Cloud Integration – Overview of OData API Documentation

SAP Cloud Integration provides you with the option to access various Cloud Integration resources through an application programming interface (API). 

This API is enhanced continuously. With this blog, I would like to summarize some facts and figures and give you the related information sources at one glance.

The Cloud Integration OData API allows you to implement scenarios where you access various Cloud Integration resources through an OData application programming interface API. The Cloud Integration OData API package contains different APIs, each providing read and write access to dedicated Cloud Integration resources:

  • Integration Content
  • Log Files
  • Message Processing Logs
  • Message Stores
  • Partner Directory
  • Security Content

Use the following information sources to learn more about the API and how to use it.

Information Source Description
API documentation on SAP API Business Hub

Provides access to the available APIs for Cloud Integration. Clicking a tile, you find documentation for a specific API, for example, Integration Content.

The documentation on SAP API Business Hub contains the essentials required to work with the API. Here, you find:

Documentation of the API resources, the supported operations, query options
Documentation of the structure of the request body (if required) and of the response bodies (for successful and error responses)

Furthermore, you can test GET requests directly on SAP API Business Hub connecting to a sandbox system.

API documentation on SAP Help Portal The documentation on SAP Help Portal contains

  • Background information regarding the Cloud Integration resources that can be accessed to through the API. For example, for the Security Content API you find Help links to the related artifacts like the keystore and the security artifacts.
  • Furthermore, you find information on how to use in order to implement a bit more complex scenarios, in particular, when you need to place more than one API call in sequence to get a specific problem solved.

For example, to get the runtime status of a deployed integration artifact, you need to execute several API calls as described at Get Runtime Status of Deployed Integration Flow.

Another example is the scenario how to get properties from message store entries created with the Persist integration flow step. See: Get Message Store Entry Properties.

  • You also find information on how to authenticate an API client (for example, Postman) to access Cloud Integration resources through the API. The configuration steps deoend on whether you use Cloud Integration in the Neo or Cloud Foundry environment.
What’s New for the Cloud Integration OData API (SAP Help Portal) Click this link to get the release notes of the latest software increments, filtered for the API enhancements.

Note that the following blog will not be maintained any more: Cloud Integration: OData API on API Business Hub