{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Celonis Process Management API Filter","description":"API documentation for Celonis APIs.","siteUrl":"https://developer.celonis.com/","keywords":"celonis developer portal, celonis apis, celonis api reference docs","lang":"en-US","llmstxt":{"hide":false,"description":"Celonis API documentation","sections":[{"title":"API Docs","description":"Available Celonis API Docs","includeFiles":["**/*.md"],"excludeFiles":[]},{"title":"API Specs","description":"All Celonis API specifications","includeFiles":["**/openapi.yaml"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"celonis-process-management-api-filter","__idx":0},"children":["Celonis Process Management API Filter"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"syntax","__idx":1},"children":["Syntax"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The filters are part of the Uri."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://Server/Collection/Database/_api/rest/facets/processes/views/tree/elements/Origin Key of Category?$filter=name -eq 'mainProcess'\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"type-of-filters--operations","__idx":2},"children":["Type of filters / operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"binary-operators","__idx":3},"children":["Binary Operators"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Syntax"},"children":["Syntax"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Equal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-eq"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Boolean equality operator."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["?$filter=name -eq string"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"function-operators","__idx":4},"children":["Function Operators"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Syntax"},"children":["Syntax"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains(string to be searched, substring to search)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines if one string occurs within another string."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["?$filter=contains(attributes, 'test')"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EndsWith"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EndsWith(string to be searched, substring to search at the end of the first string)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines if the end of one string matches another string."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["?$filter=EndsWith(attributes, 'test')"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["StartsWith"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["StartsWith(string to be searched, substring to search at the beginning of the first string)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines if the beginning of one string matches another string."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["?$filter=StartsWith(attributes, 'test')"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["IsNull"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["IsNull(key to check for null)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Compares the first operand with the null value. Compares if value null, empty or whitespace."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["?$filter=IsNull(attributes)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"operator-error","__idx":5},"children":["Operator Error"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\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","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"queries","__idx":6},"children":["Queries"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It is possible to create a query in which filters are used in combination. An example in which the value'mainprocess' in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," attribute is filtered and the value in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sate1"]}," attribute does not correspond to'in progress'."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Syntax"},"children":["Syntax"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["And"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AND"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Groups operands with logical AND"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["?$filter=name Equal string AND state1 Equal string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Or"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OR"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Groups operands with logical OR."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["?$filter=name Equal string OR state1 Equal string"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-example","__idx":7},"children":["Query example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"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"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Other combinations are also possible."]}]},"headings":[{"value":"Celonis Process Management API Filter","id":"celonis-process-management-api-filter","depth":1},{"value":"Syntax","id":"syntax","depth":2},{"value":"Type of filters / operations","id":"type-of-filters--operations","depth":2},{"value":"Binary Operators","id":"binary-operators","depth":3},{"value":"Function Operators","id":"function-operators","depth":3},{"value":"Operator Error","id":"operator-error","depth":3},{"value":"Queries","id":"queries","depth":2},{"value":"Query example","id":"query-example","depth":3}],"frontmatter":{"seo":{"title":"Celonis Process Management API Filter"}},"lastModified":"2026-02-26T22:05:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/cpm/developer/rest-api/how-to/filter","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}