Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Celonis Beta: OData Protocol API

The Beta: OData Protocol API from Celonis — 3 operation(s) for beta: odata protocol.

Celonis Beta: OData Protocol API is one of 17 APIs that Celonis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Beta: OData Protocol. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version v1.2.0.

Requests are made against a single base URL, https://30f873b4-88d4-49ba-b327-6f651d7b99e6.remockly.com.

3 operations 3 paths 7 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.2.0
Base URL
https://{team_domain}.{realm}.celonis.cloud
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Celonis Beta: OData Protocol API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as AppKey (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Beta: OData Protocol 3
GET
/intelligence/api/odata/{km_id}.svc/$metadata
OData metadata endpoint
odataMetadataResult 2 params → 200400401403404415429500
GET
/intelligence/api/odata/{km_id}.svc
OData service definition endpoint
odataServiceDefinitionResult 2 params → 200400401403404415429500
GET
/intelligence/api/odata/{km_id}.svc/{record_id}_entries
OData service data endpoint
odataServiceDataResult 10 params → 200400401403404415429500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are errorDTO (5 properties), ODataServiceDataResultPage (2 properties), ODataServiceDefinitionResultPage (2 properties), ODataServiceDefinitionXMLResultPage (2 properties). Each schema is shown below with its type and property counts.

ODataServiceDefinitionXMLResultPage
object
2 properties
ODataServiceDefinitionResultPage
object
2 properties
ODataServiceResultPage
object
1 property
ODataServiceDataXMLResultPage
object
1 property
ODataServiceDataResultPage
object
2 properties
errorDTO
object
This [RFC7807] specification is to define common error formats for those applications that need one, so that they aren't required to define their own, or worse…
5 properties
authErrorDTO
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

celonis-beta-odata-protocol-api-openapi.yml Raw ↑

Other APIs Celonis publishes across the network.

Celonis Agents - Conversation API
Celonis Beta: Semantics for 3P AI Agents API
Celonis Data API
Celonis Job Execution API
Celonis Job Execution Group API
Celonis Login History API API
Celonis Members API API
Celonis Notebook API
Celonis Notebook Execution API
Celonis Notebook Resources API
Celonis OpenAPI Tool Calling API
Celonis Permissions Export API API