Skip to content
Last updated

Reporting API (Legacy)

Important warning

The legacy APIs in this section are not recommended for new implementations. It is recommended that you use the APIs from the Business Manager section for your integrations with the Celonis Platform.

Use these APIs to get variants and version of Celonis Process Management elements.

You can access the Swagger definition of these APIs using this URL: https://pz.symbioweb.com/swagger/index.html?url=/swagger/v1/swagger.json#/Reporting%20Api%20(Version%201). Just replace pz.symbioweb.com with the hostname (and port) of your Celonis Process Management instance to get the latest definition applicable to your instance.

Scenarios

  • Use the GET {storagecollection}/{tenant}/_api/v1/reporting to page through all elements of a facet: https://pz.symbioweb.com/swagger/index.html?url=/swagger/v1/swagger.json#/Reporting%20Api%20(Version%201)/ReportingV1_Get

    The parameters facet and page are given. The pageSize is optional and must be in the range [1..1000], 100 being the default.

  • Use the GET {storagecollection}/{tenant}/_api/v1/reporting/{id} to get one specific element (and its versions and variants): https://pz.symbioweb.com/swagger/index.html?url=/swagger/v1/swagger.json#/Reporting%20Api%20(Version%201)/ReportingV1_GetById

    No additional parameters are required or available.