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 Schema API

The Schema API from Celonis — 6 operation(s) for schema.

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

Tagged areas include Schema. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths, and defines 16 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.

6 operations 6 paths 16 schemas 6 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 Schema 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 6

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

Schema 6
GET
/intelligence/api/knowledge-models
Get a list of KMs
getKnowledgeModel 3 params → 200400401403429500503
GET
/intelligence/api/knowledge-models/{km_id}
Get the top-level KM details
getKnowledgeModelDetails 1 param → 200400401403404429500503
GET
/intelligence/api/knowledge-models/{km_id}/filters
Get a list of KM Filters
getFilters 4 params → 200400401403404429500503
GET
/intelligence/api/knowledge-models/{km_id}/records
Get a list of KM Records schema
getRecords 4 params → 200400401403404429500503
GET
/intelligence/api/knowledge-models/{km_id}/records/{record_id}
Get the top-level KM Record Schema details
getRecordDetails 3 params → 200400401403404429500503
GET
/intelligence/api/knowledge-models/{km_id}/kpis
Get a list of KM KPI's schema
getKpis 4 params → 200400401403404429500503

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are recordFieldDTO (8 properties), kpiDTO (8 properties), errorDTO (5 properties), recordIdDTO (5 properties). Each schema is shown below with its type and property counts.

knowledgeModelSimplifiedDTO
object
Knowledge Model data's structure
1 property
schemaResultPage
object
4 properties
knowledgeModelDetailedDTO
object
Knowledge Model data's structure
1 property
filterDTO
object
Filter to apply in a KM
3 properties
knowledgeModelResultPage
object
1 property
recordIdDTO
object
Record Type's id and name
5 properties
recordFieldDTO
object
Fields for a Record
8 properties
recordDTO
object
Record represents a concept inside a Knowledge Model
1 property
recordSchemaResultPage
object
1 property
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
knowledgeModelIdDTO
object
Knowledge Model id and name
2 properties
filterResultPage
object
1 property
kpiSchemaResultPage
object
1 property
authErrorDTO
object
1 property
kpiDTO
object
KPI structure within the knowledge model
8 properties
kpiParameterItemDTO
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

celonis-schema-api-openapi.yml Raw ↑

Other APIs Celonis publishes across the network.

Celonis Agents - Conversation API
Celonis Beta: OData Protocol 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