{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/process-intelligence-apis/knowledge-model-api/tutorials/learning/retrieve-record-data/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Retrieving record data

\n

Once you understand how the schema endpoints work, you are ready to start getting data for the\nrecords.

\n

Data endpoint

\n

In order to get data for a record, you need to start building the URL for the Knowledge Model and record you want to\nconsume. This URL should follow this pattern:\nhttps://<team>.<cluster>.celonis.cloud/intelligence/api/knowledge-models/<km_id>/records/<record_id>/data where:

\n\n

Specifying the fields that you want to consume

\n

The above URL won't do much on its own. You need to specify the list of fields that you want to consume.

\n

Call fields to one of the following:

\n\n

In order to specify which fields you want to get data for, you need to pass a fields query parameter and specify the\nlist of field ids that you previously got from the record schema endpoint separated by commas. For example, if you want to get\nthe data for three fields called ID, ACTIVITIES and EVENTTIME, then you need to specify the query parameter in the following way:\nfields: ID, ACTIVITIES, EVENTTIME. Keep in mind that the ids are case sensitive. In Postman, this should look like this:

\n

\n \n \n

\n

If the information is correct, you should get a response like this:

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"page\": 0,\n  \"pageSize\": 50,\n  \"total\": 2,\n  \"sort\": [],\n  \"content\": {\n    \"headers\": [\n      {\n        \"id\": \"ID\",\n        \"name\": \"Id\",\n        \"type\": \"integer\",\n        \"format\": \",.0f\",\n        \"aggregation\": false,\n        \"filterable\": true,\n        \"sortable\": true\n      },\n      {\n        \"id\": \"EVENTTIME\",\n        \"name\": \"Eventtime\",\n        \"type\": \"date\",\n        \"format\": \"%Y-%m-%d\",\n        \"aggregation\": false,\n        \"filterable\": true,\n        \"sortable\": true\n      },\n      {\n        \"id\": \"ACTIVITIES\",\n        \"name\": \"Activities\",\n        \"type\": \"string\",\n        \"aggregation\": false,\n        \"filterable\": true,\n        \"sortable\": true\n      }\n    ],\n    \"data\": [\n      {\n        \"EVENTTIME\": \"2015-05-01\",\n        \"ACTIVITIES\": \"Put in the oven\",\n        \"ID\": 1\n      },\n      {\n        \"EVENTTIME\": \"2015-05-01\",\n        \"ACTIVITIES\": \"Roll out the dough\",\n        \"ID\": 0\n      }\n    ]\n  }\n}
\n
\n

Let's analyze the response:

\n\n

So, for the example above, you got two rows of data. The first one corresponds with the activity \"Put in the oven\" that has\nan id equal to 1 and happened on 2015-05-01. According to the headers you should be able to filter and sort by any of\nthe headers (id, activities or eventtime).

\n

Sorting the data

\n

For this example, you can see that the activities are not correctly ordered. You would like to have \"Roll out the dough\"\nfirst and then \"Put in the oven\" second. To achieve this, you can sort the data by the ID.

\n

For the data endpoint, you can specify a sort query parameter with the fields that you would like to use for sorting.\nThese fields need to be separated by a comma. You can also specify if you want that field to be sorted ascending or\ndescending. If you want the field to be sorted ascending you need to prepend a + character to the name of the field,\nwhereas if you want the field to be sorted descending you will need to prepend a - character. For example:\nsort: +id, -Activities will sort the data first by id ascending and then it will sort it by the activity names in a\ndescending way.

\n

In this example you wanted to sort by id, so you can just specify the following query parameter sort: id.\nNotice that the + character is optional, as it is the default criteria if no criteria is specified.

\n

Filtering the data

\n

Now, let's imagine you have hundreds or thousands of rows being returned by your query. How can you filter the entries that\nyou are interested in?

\n

There are two ways:

\n\n

Using one or more Knowledge Model filter/s

\n

Your Knowledge Model may already contain some filters. These filters can be retrieved by the\nfilters schema endpoint. For example, you could\nhave a filter with an id \"rolloutthe_dough\" that filters all the entries that have an activity with the name\n\"Roll out the dough\".

\n

If you wanted to use this filter in your query, you can simply pass it in the query parameter filters. In your example,\nyou can filter only the \"Roll out the dough\" entries with the query parameter filters: roll_out_the_dough. Similar to\nthe fields or sort, you can specify more than one filter by separating the ids by a comma.

\n

Specifying a filter expression in the request

\n

If you wanted to filter the entries that contain an activity called \"Roll out the dough\", you could also specify a filter\nexpression in your request. The filter expressions follow the pattern field operator value, where:

\n\n

So, in your example, you could achieve the same result as using a Knowledge Model filter by specifying the following query parameter:\nfilterExpr: ACTIVITIES eq 'Roll out the dough'.

\n

It is also possible to combine filters with logical operators, parenthesis and some OData predictors:

\n\n

These predictors have the following structure:

\n\n

In this example, another way to achieve the same result is by using a predictor specifying the following query parameter:\nfilterExpr: startswith(ACTIVITIES,'Roll out the dough'). You can specify multiple filter expressions, simply separating them by a comma or combining them with logical operators.

\n

Hopefully, with this information, you should now be able to get, sort and filter all the record data that you need. If\nyou got this far, we would like to hear from you. Have you found any limitation or something tha you would like us to\nimprove? If so, please fill our feedback form\nthat will help us to improve our API.

","headings":[{"value":"Retrieving record data","depth":1},{"value":"Data endpoint","depth":2},{"value":"Specifying the fields that you want to consume","depth":2},{"value":"Sorting the data","depth":2},{"value":"Filtering the data","depth":2},{"value":"Using one or more Knowledge Model filter/s","depth":3},{"value":"Specifying a filter expression in the request","depth":3}]},"contentItem":{"data":{"lastModified":"2025-10-07T17:03:39.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"525399ef-e2c3-5fd6-b187-9221b07af99a__redocly content/process-intelligence-apis/knowledge-model-api/tutorials/learning/retrieve-record-data/","seo":{"title":"Retrieving record data","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"process-intelligence-apis/knowledge-model-api/tutorials/learning/retrieve-record-data.md","pageBaseUrl":"/process-intelligence-apis/knowledge-model-api/tutorials/learning/retrieve-record-data","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Retrieving record data","id":"retrieving-record-data"},{"depth":2,"value":"Data endpoint","id":"data-endpoint"},{"depth":2,"value":"Specifying the fields that you want to consume","id":"specifying-the-fields-that-you-want-to-consume"},{"depth":2,"value":"Sorting the data","id":"sorting-the-data"},{"depth":2,"value":"Filtering the data","id":"filtering-the-data"},{"depth":3,"value":"Using one or more Knowledge Model filter/s","id":"using-one-or-more-knowledge-model-filters"},{"depth":3,"value":"Specifying a filter expression in the request","id":"specifying-a-filter-expression-in-the-request"}]},"data":{"title":""},"catalogInfo":null,"link":"/process-intelligence-apis/knowledge-model-api/tutorials/learning/retrieve-record-data/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}