Celonis
App · 16 actions
Query Celonis Knowledge Models, inspect model schemas and load status, and run data jobs or model reloads.
Actions
| Action | What it does |
|---|---|
| Execute data job | Execute data job. |
| Get data job | Get data job. |
| Get knowledge model | Get the top-level KM details. |
| Get last model load | Get last model load. |
| Get model data | Get a list of KM data. |
| Get record data | Get a list of KM Record data. |
| Get record schema | Get the top-level KM Record Schema details. |
| List filters | Get a list of KM Filters. |
| List knowledge models | Get a list of KMs. |
| List kpis | Get a list of KM KPI's schema. |
| List model tables | List model tables. |
| List records | Get a list of KM Records schema. |
| Query model data | Get a list of KM data with advanced filtering. |
| Query record data | Get a list of KM Record data with advanced filtering. |
| Reload model | Reload model. |
| Reload model tables | Reload model tables. |
Execute data job
Execute data job.
Inputs
- Pool ID
pool_idtextRequired - Data pool ID from the address of the pool in Celonis.
- Job ID
job_idtextRequired - Data job ID from the address of the job in Celonis.
- Mode
modetextRequired - Mode.One of:
FULL,DELTA.
Outputs
dataobject- Job acceptance response; use Get data job to check status.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": null,
"has_more": false,
"next_cursor": ""
}Get data job
Get data job.
Inputs
- Pool ID
pool_idtextRequired - Data pool ID from the address of the pool in Celonis.
- Job ID
job_idtextRequired - Data job ID from the address of the job in Celonis.
Outputs
dataobject- Complete response from the service, including its pagination and job status fields.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}Get knowledge model
Get the top-level KM details.
Inputs
- Km
km_idtextRequired - Km id.
Outputs
dataobject- Knowledge Model data's structure
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"extendedKMId": "",
"id": "",
"name": ""
},
"has_more": false,
"next_cursor": null
}Get last model load
Get last model load.
Inputs
- Pool ID
pool_idtextRequired - Data pool ID from the address of the pool in Celonis.
- Model ID
model_idtextRequired - Data model ID from the address of the model in Celonis.
Outputs
dataobject- Complete response from the service, including its pagination and job status fields.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {},
"has_more": false,
"next_cursor": ""
}Get model data
Get a list of KM data.
Inputs
- Km
km_idtextRequired - Km id.
- Filters
filterslist - Filters.
- Fields
fieldslist - Fields.
- Page
pagenumber - Page.At least 0.
- PageSize
pageSizenumber - Pagesize.At least 1.
- Sort
sortlist - Defines the order in which results are returned (Knowledge Model level GET). The `sortParamKm` query parameter must be a comma-separated list of record fields and/or KPIs. Any value used in `sortParamKm` **must also be included** in the `fields` or `kpis` parameters. If a value appears in `sortParamKm` but is **not** included in `fields` or `kpis`, the API cannot evaluate it and sorting will not be applied correctly. If a non-existing field is provided, the request will return an error. Sort direction is specified using optional prefixes: - `+` for ascending order (ASC) - `-` for descending order (DESC) - No prefix defaults to ascending order (ASC) **Examples** - `sortParamKm=+record1_id.field1` (sorting in ascending order by a record field) - `sortParamKm=-record1_id.field2,kpi1` (sorting in descending order by a record field and in ascending order by a KPI) - `sortParamKm=record1_id.field1,-kpi2` (sorting in ascending order by a record field and in descending order by a KPI) - `sortParamKm=-kpi1` (sorting in descending order by a KPI)
- FilterExpr
filterExprlist - Filterexpr.
- Options
optionslist - Set different **options to customize the data results** for a query. Supported options * **Distinct**: Enable the unique data results for a query
- Kpis
kpislist - Kpis.
- SearchTerm
searchTermtext - Searchterm.
- SearchPrecision
searchPrecisionnumber - Searchprecision.From 1 to 100.
- SearchField
searchFieldtext - Searchfield.
Outputs
dataobject- Complete service response.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"content": {
"data": [],
"headers": []
},
"page": 0,
"pageSize": 0,
"sort": [],
"total": 0
},
"has_more": false,
"next_cursor": null
}Get record data
Get a list of KM Record data.
Inputs
- Km
km_idtextRequired - Km id.
- Record ID
record_idtextRequired - Record id.
- Filters
filterslist - Filters.
- Fields
fieldslistRequired - Fields.
- Page
pagenumber - Page.At least 0.
- PageSize
pageSizenumber - Pagesize.At least 1.
- Sort
sortlist - Defines the order in which results are returned (record-level GET). The `sortParamRecord` query parameter must be a comma-separated list of record fields. Any value used in `sortParamRecord` **must also be included** in the `fields` parameter. If a value appears in `sortParamRecord` but is **not** included in `fields`, the API cannot evaluate it and sorting will not be applied correctly. If a non-existing field is provided, the request will return an error. Sort direction is specified using optional prefixes: - `+` for ascending order (ASC) - `-` for descending order (DESC) - No prefix defaults to ascending order (ASC) **Examples** - `sortParamRecord=+field1` (sorting in ascending order by a record field) - `sortParamRecord=-field2,field1` (sorting in descending order by a record field and in ascending order by another record field)
- FilterExpr
filterExprlist - Filterexpr.
- Options
optionslist - Set different **options to customize the data results** for a query. Supported options * **Distinct**: Enable the unique data results for a query
- SearchTerm
searchTermtext - Searchterm.
- SearchPrecision
searchPrecisionnumber - Searchprecision.From 1 to 100.
- SearchField
searchFieldtext - Searchfield.
Outputs
dataobject- Complete service response.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"content": {
"data": [],
"headers": []
},
"page": 0,
"pageSize": 0,
"sort": [],
"total": 0
},
"has_more": false,
"next_cursor": null
}Get record schema
Get the top-level KM Record Schema details.
Inputs
- Km
km_idtextRequired - Km id.
- Record ID
record_idtextRequired - Record id.
- Sort
sorttext - Defines the strategy to proceed for case insensitive sorting. It must be just one field, and it should start with "+" to apply ASC order or "-" to apply DESC order. Non prefix will sort as ASC. Non existing field at the header will throw an error
Outputs
dataobject- Record represents a concept inside a Knowledge Model
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"description": "",
"fields": [],
"id": "",
"internalNote": "",
"name": "",
"shortDisplayName": ""
},
"has_more": false,
"next_cursor": null
}List filters
Get a list of KM Filters.
Inputs
- Page
pagenumber - Page.At least 0.
- PageSize
pageSizenumber - Pagesize.At least 1.
- Sort
sorttext - Defines the strategy to proceed for case insensitive sorting. It must be just one field, and it should start with "+" to apply ASC order or "-" to apply DESC order. Non prefix will sort as ASC. Non existing field at the header will throw an error
- Km
km_idtextRequired - Km id.
Outputs
dataobject- Complete service response.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"content": [],
"page": 0,
"pageSize": 0,
"sort": "",
"total": 0
},
"has_more": false,
"next_cursor": null
}List knowledge models
Get a list of KMs.
Inputs
- Page
pagenumber - Page.At least 0.
- PageSize
pageSizenumber - Pagesize.At least 1.
- Sort
sorttext - Defines the strategy to proceed for case insensitive sorting. It must be just one field, and it should start with "+" to apply ASC order or "-" to apply DESC order. Non prefix will sort as ASC. Non existing field at the header will throw an error
Outputs
dataobject- Complete service response.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"content": [],
"page": 0,
"pageSize": 0,
"sort": "",
"total": 0
},
"has_more": false,
"next_cursor": null
}List kpis
Get a list of KM KPI's schema.
Inputs
- Page
pagenumber - Page.At least 0.
- PageSize
pageSizenumber - Pagesize.At least 1.
- Sort
sorttext - Defines the strategy to proceed for case insensitive sorting. It must be just one field, and it should start with "+" to apply ASC order or "-" to apply DESC order. Non prefix will sort as ASC. Non existing field at the header will throw an error
- Km
km_idtextRequired - Km id.
Outputs
dataobject- Complete service response.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"content": [],
"page": 0,
"pageSize": 0,
"sort": "",
"total": 0
},
"has_more": false,
"next_cursor": null
}List model tables
List model tables.
Inputs
- Pool ID
pool_idtextRequired - Data pool ID from the address of the pool in Celonis.
- Model ID
model_idtextRequired - Data model ID from the address of the model in Celonis.
Outputs
datalist- Complete response from the service, including its pagination and job status fields.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": [],
"has_more": false,
"next_cursor": ""
}List records
Get a list of KM Records schema.
Inputs
- Page
pagenumber - Page.At least 0.
- PageSize
pageSizenumber - Pagesize.At least 1.
- Sort
sorttext - Defines the strategy to proceed for case insensitive sorting. It must be just one field, and it should start with "+" to apply ASC order or "-" to apply DESC order. Non prefix will sort as ASC. Non existing field at the header will throw an error
- Km
km_idtextRequired - Km id.
Outputs
dataobject- Complete service response.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"content": [],
"page": 0,
"pageSize": 0,
"sort": "",
"total": 0
},
"has_more": false,
"next_cursor": null
}Query model data
Get a list of KM data with advanced filtering.
Inputs
- Km
km_idtextRequired - Km id.
- Projection
projectionobjectRequired - Defines the projection criteria for the Knowledge Model query.
Outputs
dataobject- Complete service response.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"content": {
"data": [],
"headers": []
},
"page": 0,
"pageSize": 0,
"sort": [],
"total": 0
},
"has_more": false,
"next_cursor": null
}Query record data
Get a list of KM Record data with advanced filtering.
Inputs
- Km
km_idtextRequired - Km id.
- Record ID
record_idtextRequired - Record id.
- Projection
projectionobjectRequired - Defines the parameters related to the query to be executed against the Knowledge Model Record.
Outputs
dataobject- Complete service response.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": {
"content": {
"data": [],
"headers": []
},
"page": 0,
"pageSize": 0,
"sort": [],
"total": 0
},
"has_more": false,
"next_cursor": null
}Reload model
Reload model.
Inputs
- Pool ID
pool_idtextRequired - Data pool ID from the address of the pool in Celonis.
- Model ID
model_idtextRequired - Data model ID from the address of the model in Celonis.
Outputs
dataobject- Load acceptance response; use Get last model load to check completion.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": null,
"has_more": false,
"next_cursor": ""
}Reload model tables
Reload model tables.
Inputs
- Pool ID
pool_idtextRequired - Data pool ID from the address of the pool in Celonis.
- Model ID
model_idtextRequired - Data model ID from the address of the model in Celonis.
- Table IDS
table_idslistRequired - Table ids.
Outputs
dataobject- Load acceptance response.
has_moretrue/false- Whether the service reports another page.
next_cursortext- Cursor for the next page, when supplied by the service.
Example output
{
"data": null,
"has_more": false,
"next_cursor": ""
}