Message Format for Requests and Responses

The Integration event monitoring APIs uses the JSON message format for API requests and responses.

API Request Format

GET /{api-version}/events/status

Note

Vanity URLs are not supported by the Integration event monitoring API. This means that API calls with URLs in the following format are not supported:

https://orgabc.ariba.com/Sourcing/v2/events/status

Instead, the following types of URLs are supported for shared-secret-based authentication and certificate-based authentication.

Shared-secret-based authentication URL:

{{runtime_url}}status?realm=orgabc

Certificate-based authentication URL:

{{runtime_url}status?realm=orgabc

Header Name	Mandatory	Description
eventname	No	This can be the TopicName, or the ITKDisplayName, or the Event Display Name. For example."Import Batch Data" or "CombinedDataPull".
histcount	No	This can be an integer value from 1 to 50. Based on the value specified, the API retrieves the event status history. For example, if the value is 2, it retrieves the last 2 statuses of the integration event.
uid	No	This is the unique identifier key. It is used to retrieve the history of the events. Based on the value specified, the API tries to retrieve the status of the event for that particular run. Note The API cannot retrieve data older than 6 months.
sharedSecret	No	If the authentication mode is shared secret, then this header needs to be present. The value is the shared secret.
Authorization	No	If the authentication mode is OAuth and the API is accessed from the SAP Ariba Developer Portal, then this header needs to be used. The value is the access_token.

Parameter Name	Mandatory	Description
realm	Yes	The site name for which the query is being run. For example, p2pTeSap.