{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/cpm/developer/rest-api/how-to/filter/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Celonis Process Management API Filter

\n

Filters can be part of the Uri and cause the server to return a filtered amount of data. For example, you can query all elements with a specific name specified in the filter.

\n

Syntax

\n

The filters are part of the Uri.

\n
\n
\n
Copy
\n
Copied
\n
\n 
https://Server/Collection/Database/_api/rest/facets/processes/views/tree/elements/Origin Key of Category?$filter=name -eq 'mainProcess'
\n
\n

Type of filters / operations

\n

Binary Operators

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameSyntaxTypeDescriptionExample
Equal-eqstringThe Boolean equality operator.?$filter=name -eq string
\n

Function Operators

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameSyntaxTypeDescriptionExample
ContainsContains(string to be searched, substring to search)stringDetermines if one string occurs within another string.?$filter=contains(attributes, 'test')
EndsWithEndsWith(string to be searched, substring to search at the end of the first string)stringDetermines if the end of one string matches another string.?$filter=EndsWith(attributes, 'test')
StartsWithStartsWith(string to be searched, substring to search at the beginning of the first string)stringDetermines if the beginning of one string matches another string.?$filter=StartsWith(attributes, 'test')
IsNullIsNull(key to check for null)stringCompares the first operand with the null value. Compares if value null, empty or whitespace.?$filter=IsNull(attributes)
\n

Operator Error

\n

If you use an invalid filter operant, you get either a code 404 for an invalid uri or a hint that this operator is not implemented.

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"data\": [\n        {\n            \"error\": \"The operator Custom is currently not supported\"\n        }\n    ],\n    \"message\": \"An error occurred.\",\n    \"output\": \"Volatile\",\n    \"type\": \"Error\"\n}
\n
\n

Queries

\n

It is possible to create a query in which filters are used in combination. An example in which the value'mainprocess' in the name attribute is filtered and the value in the sate1 attribute does not correspond to'in progress'.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameSyntaxTypeDescriptionExample
AndANDstringGroups operands with logical AND?$filter=name Equal string AND state1 Equal string
OrORstringGroups operands with logical OR.?$filter=name Equal string OR state1 Equal string
\n

Query example

\n
\n
\n
Copy
\n
Copied
\n
\n 
https://Server/Collection/Database/_api/rest/facets/processes/views/tree/elements/Origin Key of Category?$filter=name -eq 'mainProcess' AND state1 -eq 'in progress'
\n
\n

Other combinations are also possible.

","headings":[{"value":"Celonis Process Management API Filter","depth":1},{"value":"Syntax","depth":2},{"value":"Type of filters / operations","depth":2},{"value":"Binary Operators","depth":3},{"value":"Function Operators","depth":3},{"value":"Operator Error","depth":3},{"value":"Queries","depth":2},{"value":"Query example","depth":3}]},"contentItem":{"data":{"lastModified":"2025-09-10T14:16:09.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"0d387ac3-35bf-5059-878c-5184479c39e8__redocly content/cpm/developer/rest-api/how-to/filter/","seo":{"title":"Celonis Process Management API Filter","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/rest-api/how-to/filter.md","pageBaseUrl":"/cpm/developer/rest-api/how-to/filter","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Celonis Process Management API Filter","id":"celonis-process-management-api-filter"},{"depth":2,"value":"Syntax","id":"syntax"},{"depth":2,"value":"Type of filters / operations","id":"type-of-filters--operations"},{"depth":3,"value":"Binary Operators","id":"binary-operators"},{"depth":3,"value":"Function Operators","id":"function-operators"},{"depth":3,"value":"Operator Error","id":"operator-error"},{"depth":2,"value":"Queries","id":"queries"},{"depth":3,"value":"Query example","id":"query-example"}]},"data":{"title":""},"catalogInfo":null,"link":"/cpm/developer/rest-api/how-to/filter/","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"]}