# Celonis

> Query Celonis Knowledge Models, inspect model schemas and load status, and run data jobs or model reloads.

App · 16 actions. Web page: https://docs.lodol.com/docs/integrations/celonis

## Actions

### Execute data job

Execute data job.

**Inputs**

- Pool ID (`pool_id`, text, required): Data pool ID from the address of the pool in Celonis.
- Job ID (`job_id`, text, required): Data job ID from the address of the job in Celonis.
- Mode (`mode`, text, required): Mode. One of: `FULL`, `DELTA`.

**Outputs**

- `data` (object): Job acceptance response; use Get data job to check status.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Get data job

Get data job.

**Inputs**

- Pool ID (`pool_id`, text, required): Data pool ID from the address of the pool in Celonis.
- Job ID (`job_id`, text, required): Data job ID from the address of the job in Celonis.

**Outputs**

- `data` (object): Complete response from the service, including its pagination and job status fields.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": ""
}
```

### Get knowledge model

Get the top-level KM details.

**Inputs**

- Km (`km_id`, text, required): Km id.

**Outputs**

- `data` (object): Knowledge Model data's structure
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": {
    "extendedKMId": "",
    "id": "",
    "name": ""
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get last model load

Get last model load.

**Inputs**

- Pool ID (`pool_id`, text, required): Data pool ID from the address of the pool in Celonis.
- Model ID (`model_id`, text, required): Data model ID from the address of the model in Celonis.

**Outputs**

- `data` (object): Complete response from the service, including its pagination and job status fields.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": ""
}
```

### Get model data

Get a list of KM data.

**Inputs**

- Km (`km_id`, text, required): Km id.
- Filters (`filters`, list): Filters.
- Fields (`fields`, list): Fields.
- Page (`page`, number): Page. At least 0.
- PageSize (`pageSize`, number): Pagesize. At least 1.
- Sort (`sort`, list): 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 (`filterExpr`, list): Filterexpr.
- Options (`options`, list): Set different **options to customize the data results** for a query. Supported options * **Distinct**: Enable the unique data results for a query
- Kpis (`kpis`, list): Kpis.
- SearchTerm (`searchTerm`, text): Searchterm.
- SearchPrecision (`searchPrecision`, number): Searchprecision. From 1 to 100.
- SearchField (`searchField`, text): Searchfield.

**Outputs**

- `data` (object): Complete service response.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "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_id`, text, required): Km id.
- Record ID (`record_id`, text, required): Record id.
- Filters (`filters`, list): Filters.
- Fields (`fields`, list, required): Fields.
- Page (`page`, number): Page. At least 0.
- PageSize (`pageSize`, number): Pagesize. At least 1.
- Sort (`sort`, list): 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 (`filterExpr`, list): Filterexpr.
- Options (`options`, list): Set different **options to customize the data results** for a query. Supported options * **Distinct**: Enable the unique data results for a query
- SearchTerm (`searchTerm`, text): Searchterm.
- SearchPrecision (`searchPrecision`, number): Searchprecision. From 1 to 100.
- SearchField (`searchField`, text): Searchfield.

**Outputs**

- `data` (object): Complete service response.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "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_id`, text, required): Km id.
- Record ID (`record_id`, text, required): Record id.
- Sort (`sort`, text): 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**

- `data` (object): Record represents a concept inside a Knowledge Model
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": {
    "description": "",
    "fields": [],
    "id": "",
    "internalNote": "",
    "name": "",
    "shortDisplayName": ""
  },
  "has_more": false,
  "next_cursor": null
}
```

### List filters

Get a list of KM Filters.

**Inputs**

- Page (`page`, number): Page. At least 0.
- PageSize (`pageSize`, number): Pagesize. At least 1.
- Sort (`sort`, text): 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_id`, text, required): Km id.

**Outputs**

- `data` (object): Complete service response.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "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 (`page`, number): Page. At least 0.
- PageSize (`pageSize`, number): Pagesize. At least 1.
- Sort (`sort`, text): 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**

- `data` (object): Complete service response.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "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 (`page`, number): Page. At least 0.
- PageSize (`pageSize`, number): Pagesize. At least 1.
- Sort (`sort`, text): 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_id`, text, required): Km id.

**Outputs**

- `data` (object): Complete service response.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "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_id`, text, required): Data pool ID from the address of the pool in Celonis.
- Model ID (`model_id`, text, required): Data model ID from the address of the model in Celonis.

**Outputs**

- `data` (list): Complete response from the service, including its pagination and job status fields.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}
```

### List records

Get a list of KM Records schema.

**Inputs**

- Page (`page`, number): Page. At least 0.
- PageSize (`pageSize`, number): Pagesize. At least 1.
- Sort (`sort`, text): 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_id`, text, required): Km id.

**Outputs**

- `data` (object): Complete service response.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "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_id`, text, required): Km id.
- Projection (`projection`, object, required): Defines the projection criteria for the Knowledge Model query.

**Outputs**

- `data` (object): Complete service response.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "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_id`, text, required): Km id.
- Record ID (`record_id`, text, required): Record id.
- Projection (`projection`, object, required): Defines the parameters related to the query to be executed against the Knowledge Model Record.

**Outputs**

- `data` (object): Complete service response.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "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_id`, text, required): Data pool ID from the address of the pool in Celonis.
- Model ID (`model_id`, text, required): Data model ID from the address of the model in Celonis.

**Outputs**

- `data` (object): Load acceptance response; use Get last model load to check completion.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```

### Reload model tables

Reload model tables.

**Inputs**

- Pool ID (`pool_id`, text, required): Data pool ID from the address of the pool in Celonis.
- Model ID (`model_id`, text, required): Data model ID from the address of the model in Celonis.
- Table IDS (`table_ids`, list, required): Table ids.

**Outputs**

- `data` (object): Load acceptance response.
- `has_more` (true/false): Whether the service reports another page.
- `next_cursor` (text): Cursor for the next page, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}
```
