Discovery API

An open, read-only OData API that lets external tools discover how the ASAPIO Integration Add-on is configured on a customer's SAP system — installed connector types, configured connections, and inbound/outbound interfaces, including status flags, endpoint details, linked events, and header attributes.

Overview

The Discovery API exposes the ASAPIO Integration Add-on configuration in a discoverable, read-only OData model. Use it to inspect which connectors are installed, how connections are configured, and which interfaces run on top of them.

Who uses it

The API is open to partners. It is consumed, for example, by:

• the Whitepaper.id Integration Cockpit, and
• the Landscape Explorer in the ASAPIO Event Studio.

Operating model

• The API runs on the customer's own SAP instance and is operated there together with the ASAPIO Integration Add-on — there is no separate deployment.
• It is read-only: consumers can discover and visualise the integration configuration, but cannot change it through this API.
• Availability follows the ASAPIO Integration Add-on on that instance.

Availability

• The Discovery API is part of the ASAPIO Integration Add-on as of release 9.32607 ("July 2026").
• For earlier releases, and for the current OEM release for SAP Advanced Event Mesh, the API is shipped as a separate installation file — please request your additional download / installation file from ASAPIO.

Enabling the OData service

The Discovery API is an OData V2 service registered through SAP Gateway. After the ASAPIO Integration Add-on is installed, an administrator activates the service once per system. The procedure is the same for SAP ECC (with embedded SAP Gateway, component SAP_GWFND) and SAP S/4HANA.

Prerequisites

• The ASAPIO Integration Add-on is installed (see Availability).
• The SAP Gateway / OData foundation (SAP_GWFND) is available and the Gateway framework is active.
• You hold administration authorization for the Gateway service-maintenance transactions.

Activate the service

1. Open transaction /IWFND/MAINT_SERVICE (Activate and Maintain Services).
2. Choose Add Service.
3. Enter the System Alias: use LOCAL for an embedded Gateway deployment (the default on S/4HANA and on most ECC systems), or your backend alias for a hub deployment.
4. Search for the Discovery API technical service name as listed in the ASAPIO installation note, then select it.
5. Choose Add Selected Services, assign a package and transport (or local $TMP), and confirm. The service and its ICF node are registered and activated.
6. Confirm the service shows an active (green) status in /IWFND/MAINT_SERVICE, and that its node under /sap/opu/odata/… is active in transaction SICF.

Test the activation

Call the service metadata with the SAP Gateway Client (/IWFND/GW_CLIENT) or a browser:

GET /sap/opu/odata/<namespace>/<SERVICE_NAME>/$metadata

A 200 OK response returning the EDMX metadata document confirms the service is reachable. You can then call the entity sets described in the API Reference.

Authorization

• All endpoints require display authorization for the ASAPIO configuration (authorization object /ASADEV/CU, activity 03).
• If the authorization is missing, the request fails with a business error ("No authorization …").
• Access restriction per user or instance is not handled inside the service — it must be configured at the calling system or user-permission level.

API Reference

{
  "d": {
    "results": [
      {
        "ConnectorId": "AZURE",
        "isInstalled": true,
        "isActive": true,
        "HeaderAttributes": "REGION=westeurope,RETRY=3",
        "LoadType": "Real-time",
        "DataLayer": "ASAPIO Payload",
        "ASAPIOPayload": "ZACI_SALESORDER",
        "ASAPIOPayloadVersion": "0001",
        "TableView": ""
      }
    ]
  }
}

{
  "d": {
    "InterfaceId": "SALESORDER_OUT",
    "ConnectionId": "PRD_AZURE",
    "Direction": "Outbound",
    "MessageType": "BUS2032",
    "lastRun": "2026-04-24T09:15:00Z",
    "isActive": true,
    "Events": "CREATED,CHANGED",
    "HeaderAttributes": "TOPIC=sales-orders",
    "LoadType": "Real-time",
    "DataLayer": "ASAPIO Payload",
    "ASAPIOPayload": "ZACI_SALESORDER",
    "ASAPIOPayloadVersion": "0001",
    "TableView": ""
  }
}

Schemas

Practical Consumer Notes

• ConnectionId is the ASAPIO instance key and primary navigation anchor.
• Hostname / Port / SSL are populated only for HTTP-type RFC destinations.
• ConnectorSet intentionally excludes non-installed connector types.
• For interfaces, prefer navigation or $filter by ConnectionId — this keeps responses small and predictable:
  • GET /ConnectionSet('{id}')/ToInterfaces
  • GET /InterfaceSet?$filter=ConnectionId eq '{id}'
• Events and HeaderAttributes are always populated regardless of isActive status.
• HeaderAttributes are returned as a flat NAME=VALUE string — split on comma if individual values are needed.