Retrieving Integration Events Using the Integration Event Monitoring Query API

Use this procedure to retrieve integration events using the Integration Event Monitoring Query API.

Context

The following steps describe the process to retrieve integration events using the Integration Event Monitoring Query API for SAP Ariba solutions and SAP Business Network.

Request header parameters

The following header is required for request validation:

Header name

Mandatory

Description

apikey

Yes

The API key is validated against the token provided in the request header.

Procedure

  1. The client application submits the request for a list of all integration events, using the GET / products/{productid}/events endpoint. Specifying the tenantID and the time period for which the events need to be retrieved in the filter parameters is mandatory. 
    GET {{runtime_url}}/products/{productid}/events?$count={count}&$filter=(tenantId eq {tenantID}) and (eventTimeStamp gt {timestamp}) and (eventTimeStamp lt {timestamp})
    productid
    The unique identifier of the SAP Ariba solutions to retrieve events specific to the solution. The supported product ID values are as follows:

    • Buyer

    • Sourcing

    • AN

    • CIG

    • MDNI

    • SLP

    The response contains a list of integration events.

  2. Optional. The client application requests for specific events by specifying the appropriate filters using the GET / products/{productid}/events endpoint. 
    GET {{runtime_url}}/products/{productid}/events?$count={count}&$filter=(tenantId eq {tenanatID}) and (eventTimeStamp gt {timestamp}) and (eventTimeStamp lt {timestamp})
    $filter
    The OData filter criteria to restrict the dataset. It must have three filters which specify the tenantid and the time interval, with the format intervalStartTime ge datetime and intervalEndTime lt datetime. The time must be in UTC. Other filters are optional.
    $top
    The number of records to be returned in the response.
    $skip
    The number of records to be skipped from the beginning of the search results.
    $count
    The total number of entries available for collection when the filters are applied, and the number of entries contained in a particular response. Includes count in the output along with data, if set to true.

    The response contains a list of integration events.