There are different types of APIs with different scopes, benefits and intended audiences, which makes each of them uniquely suited for their unique purposes.\nThe Knowledge Model API is a generic purpose API, supporting pure REST and serving any use case. However, it turns out that industry protocol standards can speed up integration and guarantee native interoperability with numerous cloud platforms without the need to build a dedicated connector.
\nOData is one of the most popular industry API protocol standards in in recent years, adopted by many commercial platforms (such as Microsoft, SAP, Salesforce, etc.) as well as most of the analytics and business intelligence platforms (including Tableau, PowerBI, and SAP Analytics cloud).\nWhereas REST is an architectural style solely concerned with data transfer via web service APIs, OData builds upon REST architecture with a set of metadata that can be easily integrated into most programming and scripting languages.\nOData provides self-discoverability and standard functionality, thus helping applications to focus on business logic without worrying about the various API approaches to define request and response headers, status codes, HTTP methods, URL conventions, media types, payload formats, query options, etc.
\nThere is no need for development skills to manage and make use of OData integration. It can be handled by personas like:
\nThe OData service definition is the mechanism used to define what data is exposed with OData, how, and to whom. Data is exposed as OData collections. Refer to OData doc: 3 Service Root URL.\nEvery Celonis Knowledge Model (KM) dynamically generates an OData service including collections of KM records, thus making the KM queryable. The path to access the KM OData service is GET {{base-path}}/odata/{{km-id}}.svc\nBy sending the request GET https:://{{team}}{{realm}}.celonis.cloud/intelligence/api/odata/{{km-id}}.svc, one gets:
Accept=application/xml\n , \n$format=application/xml\n or \n$format=xml\n\n\nOData metadata documents describe the Entity Data Model (EDM) for a given service, which is the underlying abstract data model used by OData services to formalize the description of the resources it exposes. Refer to OData doc: 4.1 Addressing the Model for a Service.\nEvery Celonis Knowledge Model (KM) dynamically generates their OData metadata including the schema of each KM record, thus making the KM self-discoverable.\nThe path to access the KM OData metadata is GET {{base-path}}/odata/{{km-id}}.svc/$metadata\nBy sending the request GET https:://{{team}}{{realm}}.celonis.cloud/intelligence/api/odata/{{km-id}}.svc/$metadata, one gets:
Accept=application/xml\n , \n$format=application/xml\n or \n$format=xml\n\n\nAccept=application/json\n , \n$format=application/json\n or \n$format=json\n\n\nOData specifies a simple, yet powerful query language that allows a client to request arbitrary field selection, filtering, sorting, paging and so on. A client is able to express, via query string parameters, the amount and order of the data that an OData service returns for the resource identified by the URI. Every Celonis Knowledge Model (KM) record allows consumer to query them via OData query syntax described at Odata doc: 5 Query Options.\nThe path to query the KM record via OData protocol is GET {{base-path}}/odata/{{km-id}}.svc/{{record-id}}\nBy sending the request GET https:://{{team}}{{realm}}.celonis.cloud/intelligence/api/odata/{{km-id}}.svc/{{record-id}}, one gets:
Accept=application/xml\n , \n$format=application/xml\n or \n$format=xml\n\n\nAccept=application/json\n , \n$format=application/json\n or \n$format=json\n\n\n$filter\n: Refer to the OData doc \n5.1.2 System Query Option $filter\n$select\n: Refer to the OData doc \n5.1.4 System Query Option $select\n \n$orderby\n: Refer to the OData doc \n5.1.5 System Query Option $orderby\n$top\n and \n$skip\n: Refer to the OData doc \n5.1.6 System Query Options $top and $skip\n$format\n: Refer to the OData doc \n3 Requesting the JSON Format\n$count=true\n: Refer to the OData doc \n5.1.7 System Query Option $count\nfilterid\n: A custom option that allows the usage of predefined KM filters\nExample of a query URI:\n\nhttps://apinauts.develop.celonis.cloud/intelligence/api/odata/poc-ms-excel-1.svc/O_CELONIS_ORDER?$select=ID,CREATIONTIME&$orderby=ID desc&$filter=CREATIONTIME gt 2024-04-25&$top=1000&$skip=10&filterid=this_quarter\nThe procedure to create an Import Data Connection from an OData Source into SAP Analytics Cloud takes a few clicks as described at SAP Analytics Cloud Documentation.
\nThis example illustrates how to connect Tableau to an OData data source.
\nAfter adding the Microsoft Power Query for Excel, one can easily connect to Celonis by following the below simple steps:
\n{{base-path}}/odata/{{km-id}}.svc/{{record-id}}?{{parameter-value-list}}\nhttps://apinauts.develop.celonis.cloud/intelligence/api/odata/poc-ms-excel-1.svc/O_CELONIS_ORDER?$select=ID,CREATIONTIME&$orderby=ID desc&$filter=CREATIONTIME gt 2024-04-25&$top=1000&$skip=10\nPlease contact your Celonis account team if you want to join the OData Beta program.
\n↩\n