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

Configuration

\n

api-version: 1.0

\n

Retrieves the configuration of possible elements in a view.

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET /{collectionId}/{storageId}/_api/rest/facets/{facetId}/views/{viewId}/config/{type}
\n
\n

Parameters

\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\n\n\n\n\n\n\n
NameInRequiredTypeDescription
collectionIdpathtruestringThe ID of the storage collection.
storageIdpathtruestringThe ID of the tenant.
facetIdpathtruestringThe name of the facet.
viewIdpathtruestringThe name of the view.
typepathtruestringThe name of element type.
\n

Responses

\n

Success 200

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
countintegerThe number of returned values.
valuesElementTypeThe list of element types.
\n

Error 4xx

\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
NameTypeDescription
messagestringThe error message
outputOperationResultOutputThe result output.
typeOperationResultTypeThe result type.
dataOperationErrorThe list of errors.
\n

Examples

\n

Get the elements config by type from the tree view of the processes facet

\n

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/config/processhouse
\n
\n

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 1,\n    \"values\": [\n        {\n            \"key\": \"processHouse\",\n            \"displayNames\": {\n                \"1031\": \"Prozesshaus\",\n                \"1033\": \"Process House\"\n            },\n            \"descriptions\": {\n                \"1031\": \"\",\n                \"1033\": \"\"\n            },\n            \"properties\": [\n                {\n                    \"key\": \"name\",\n                    \"displayNames\": {\n                        \"1031\": \"Name\",\n                        \"1033\": \"Name\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"Name des Elements.\",\n                        \"1033\": \"Name of element.\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"Name des Elements.\",\n                        \"1033\": \"Name of element.\"\n                    },\n                    \"attribute\": {\n                        \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\n                        \"dataType\": \"MultiLineText\",\n                        \"isInvariantCulture\": false\n                    }\n                },\n                {\n                    \"key\": \"stereotype\",\n                    \"displayNames\": {\n                        \"1031\": \"Stereotyp\",\n                        \"1033\": \"Stereotype\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"\",\n                        \"1033\": \"\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"\",\n                        \"1033\": \"\"\n                    },\n                    \"attribute\": {\n                        \"type\": \"Symbio.Base.Framework.Method.ISelectableValue, Symbio.Base.Framework, Version=1906.0.0.0, Culture=neutral, PublicKeyToken=null\",\n                        \"dataType\": \"SelectionValue\",\n                        \"isInvariantCulture\": true,\n                        \"selectableValues\": []\n                    }\n                },\n                {\n                    \"key\": \"version\",\n                    \"displayNames\": {\n                        \"1031\": \"Version\",\n                        \"1033\": \"Version\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"\",\n                        \"1033\": \"\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"\",\n                        \"1033\": \"\"\n                    },\n                    \"attribute\": {\n                        \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\n                        \"dataType\": \"SingleLineText\",\n                        \"isInvariantCulture\": true\n                    }\n                },\n                {\n                    \"key\": \"state1\",\n                    \"displayNames\": {\n                        \"1031\": \"Status\",\n                        \"1033\": \"State\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"Aktuelle Phase im Lebenszyklus eines Elements.\",\n                        \"1033\": \"Current phase of an element's life-cycle.\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"Aktuelle Phase im Lebenszyklus eines Elements.\",\n                        \"1033\": \"Current phase of an element's life-cycle.\"\n                    },\n                    \"attribute\": {\n                        \"type\": \"Symbio.Base.Framework.Method.ISelectableValue, Symbio.Base.Framework, Version=1906.0.0.0, Culture=neutral, PublicKeyToken=null\",\n                        \"dataType\": \"SelectionValue\",\n                        \"isInvariantCulture\": true,\n                        \"selectableValues\": []\n                    }\n                },\n                {\n                    \"key\": \"processMaturity\",\n                    \"displayNames\": {\n                        \"1031\": \"Reifegrad\",\n                        \"1033\": \"Maturity\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"\",\n                        \"1033\": \"\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"Das Maß für den Erfüllungsgrad definierter Kriterien bezüglich Prozess-Qualität.\",\n                        \"1033\": \"The measure for the degree of fulfillment of defined criteria regarding process quality.\"\n                    },\n                    \"attribute\": {\n                        \"type\": \"Symbio.Base.Framework.Method.ISelectableValue, Symbio.Base.Framework, Version=1906.0.0.0, Culture=neutral, PublicKeyToken=null\",\n                        \"dataType\": \"SelectionValue\",\n                        \"isInvariantCulture\": true,\n                        \"selectableValues\": [\n                            {\n                                \"displayNames\": {\n                                    \"1031\": \"Nicht relevant\",\n                                    \"1033\": \"Not relevant\"\n                                },\n                                \"descriptions\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                },\n                                \"tooltips\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                }\n                            },\n                            {\n                                \"key\": \"defined\",\n                                \"displayNames\": {\n                                    \"1031\": \"10% - Prozess definiert\",\n                                    \"1033\": \"10% - Process defined\"\n                                },\n                                \"descriptions\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                },\n                                \"tooltips\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                }\n                            },\n                            {\n                                \"key\": \"implemented\",\n                                \"displayNames\": {\n                                    \"1031\": \"30% - Prozess implementiert\",\n                                    \"1033\": \"30% - Process implemented\"\n                                },\n                                \"descriptions\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                },\n                                \"tooltips\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                }\n                            },\n                            {\n                                \"key\": \"trained\",\n                                \"displayNames\": {\n                                    \"1031\": \"40% - Prozess geschult\",\n                                    \"1033\": \"40% - Process trained\"\n                                },\n                                \"descriptions\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                },\n                                \"tooltips\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                }\n                            },\n                            {\n                                \"key\": \"isLived\",\n                                \"displayNames\": {\n                                    \"1031\": \"60% - Prozess wird gelebt\",\n                                    \"1033\": \"60% - Process is lived\"\n                                },\n                                \"descriptions\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                },\n                                \"tooltips\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                }\n                            },\n                            {\n                                \"key\": \"isMeasured\",\n                                \"displayNames\": {\n                                    \"1031\": \"80% - Prozess wird gemessen\",\n                                    \"1033\": \"80% - Process is measured\"\n                                },\n                                \"descriptions\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                },\n                                \"tooltips\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                }\n                            },\n                            {\n                                \"key\": \"getsImproved\",\n                                \"displayNames\": {\n                                    \"1031\": \"100% - Prozess wird kontinuierlich optimiert\",\n                                    \"1033\": \"100% - Process get improved\"\n                                },\n                                \"descriptions\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                },\n                                \"tooltips\": {\n                                    \"1031\": \"\",\n                                    \"1033\": \"\"\n                                }\n                            }\n                        ]\n                    }\n                },\n                {\n                    \"key\": \"owner\",\n                    \"displayNames\": {\n                        \"1031\": \"Verantwortlich\",\n                        \"1033\": \"Responsible\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"\",\n                        \"1033\": \"\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"Üblicherweise gibt dieser Benutzer die Elementbeschreibung frei.\",\n                        \"1033\": \"This user releases the element description.\"\n                    },\n                    \"related\": {\n                        \"relatedTypes\": [],\n                        \"canAddNew\": false,\n                        \"maxOccurrence\": 1,\n                        \"readOnly\": false,\n                        \"facet\": \"users\"\n                    }\n                },\n                {\n                    \"key\": \"author\",\n                    \"displayNames\": {\n                        \"1031\": \"Autor\",\n                        \"1033\": \"Author\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"Der Benutzer, der die Elementbeschreibung erstellt oder betreut.\",\n                        \"1033\": \"The user, who creates or cares for the element description.\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"Der Benutzer, der die Elementbeschreibung erstellt oder betreut.\",\n                        \"1033\": \"The user, who creates or cares for the element description.\"\n                    },\n                    \"related\": {\n                        \"relatedTypes\": [],\n                        \"canAddNew\": false,\n                        \"maxOccurrence\": 1,\n                        \"readOnly\": false,\n                        \"facet\": \"users\"\n                    }\n                },\n                {\n                    \"key\": \"description\",\n                    \"displayNames\": {\n                        \"1031\": \"Beschreibung\",\n                        \"1033\": \"Description\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"\",\n                        \"1033\": \"\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"Zusätzlicher Beschreibungstext des Elements.\",\n                        \"1033\": \"Additional description text of the current element.\"\n                    },\n                    \"attribute\": {\n                        \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\n                        \"dataType\": \"Html\",\n                        \"isInvariantCulture\": false\n                    }\n                }\n            ],\n            \"layouts\": [\n                {\n                    \"key\": \"detailed\",\n                    \"displayNames\": {\n                        \"1031\": \"Detailliert\",\n                        \"1033\": \"Detailed\"\n                    }\n                },\n                {\n                    \"key\": \"graphic\",\n                    \"displayNames\": {\n                        \"1031\": \"Grafik\",\n                        \"1033\": \"Graphic\"\n                    }\n                }\n            ]\n        }\n    ]\n}
\n
\n

Get the elements config from the tree view of the processes facet

\n

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/config
\n
\n

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
The code is not displayed because over 50000 lines long.
\n
\n

Get the configuration of the process graphic

\n

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/diagram/config
\n
\n

Reponse (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 5,\n    \"values\": [\n        {\n            \"key\": \"processHouse\",\n            \"displayNames\": {\n                \"1031\": \"Prozesshaus\",\n                \"1033\": \"Process House\"\n            },\n            \"descriptions\": {\n                \"1031\": \"\",\n                \"1033\": \"\"\n            },\n            \"properties\": [\n                {\n                    \"key\": \"name\",\n                    \"displayNames\": {\n                        \"1031\": \"Name\",\n                        \"1033\": \"Name\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"Name des Elements.\",\n                        \"1033\": \"Name of element.\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"Name des Elements.\",\n                        \"1033\": \"Name of element.\"\n                    },\n                    \"attribute\": {\n                        \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\n                        \"dataType\": \"MultiLineText\",\n                        \"isInvariantCulture\": false\n                    }\n                }\n            ]\n        },\n        {\n            \"key\": \"subCategory\",\n            \"displayNames\": {\n                \"1031\": \"Kategorie\",\n                \"1033\": \"Category\"\n            },\n            \"descriptions\": {\n                \"1031\": \"\",\n                \"1033\": \"\"\n            },\n            \"properties\": [\n                {\n                    \"key\": \"name\",\n                    \"displayNames\": {\n                        \"1031\": \"Name\",\n                        \"1033\": \"Name\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"Name des Elements.\",\n                        \"1033\": \"Name of element.\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"Name des Elements.\",\n                        \"1033\": \"Name of element.\"\n                    },\n                    \"attribute\": {\n                        \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\n                        \"dataType\": \"MultiLineText\",\n                        \"isInvariantCulture\": false\n                    }\n                }\n            ]\n        },\n        {\n            \"key\": \"mainProcess\",\n            \"displayNames\": {\n                \"1031\": \"Main Process\",\n                \"1033\": \"Main Process\"\n            },\n            \"descriptions\": {\n                \"1031\": \"\",\n                \"1033\": \"\"\n            },\n            \"properties\": [\n                {\n                    \"key\": \"name\",\n                    \"displayNames\": {\n                        \"1031\": \"Name\",\n                        \"1033\": \"Name\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"Name des Elements.\",\n                        \"1033\": \"Name of element.\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"Name des Elements.\",\n                        \"1033\": \"Name of element.\"\n                    },\n                    \"attribute\": {\n                        \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\n                        \"dataType\": \"MultiLineText\",\n                        \"isInvariantCulture\": false\n                    }\n                }\n            ]\n        },\n        {\n            \"key\": \"subProcess\",\n            \"displayNames\": {\n                \"1031\": \"Sub Process\",\n                \"1033\": \"Sub Process\"\n            },\n            \"descriptions\": {\n                \"1031\": \"\",\n                \"1033\": \"\"\n            },\n            \"properties\": [\n                {\n                    \"key\": \"name\",\n                    \"displayNames\": {\n                        \"1031\": \"Name\",\n                        \"1033\": \"Name\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"Name des Elements.\",\n                        \"1033\": \"Name of element.\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"Name des Elements.\",\n                        \"1033\": \"Name of element.\"\n                    },\n                    \"attribute\": {\n                        \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\n                        \"dataType\": \"MultiLineText\",\n                        \"isInvariantCulture\": false\n                    }\n                }\n            ]\n        },\n        {\n            \"key\": \"view\",\n            \"displayNames\": {\n                \"1031\": \"View\",\n                \"1033\": \"View\"\n            },\n            \"descriptions\": {\n                \"1031\": \"\",\n                \"1033\": \"\"\n            },\n            \"properties\": [\n                {\n                    \"key\": \"name\",\n                    \"displayNames\": {\n                        \"1031\": \"Name\",\n                        \"1033\": \"Name\"\n                    },\n                    \"descriptions\": {\n                        \"1031\": \"Name des Elements.\",\n                        \"1033\": \"Name of element.\"\n                    },\n                    \"tooltips\": {\n                        \"1031\": \"Name des Elements.\",\n                        \"1033\": \"Name of element.\"\n                    },\n                    \"attribute\": {\n                        \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\n                        \"dataType\": \"MultiLineText\",\n                        \"isInvariantCulture\": false\n                    }\n                }\n            ]\n        }\n    ]\n}
\n
\n

Definitions

\n

ElementType

\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
NameTypeDescription
keystringThe API name of the type.
displayNamesstringThe localized display names of the type.
descriptionsstringThe localized descriptions of the type.
propertiesThe properties of the type.
\n

OperationResult

\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
NameTypeDescription
dataOperationErrorError data
messagestringError message
outputOperationResultOutputResult output
typeOperationResultTypeResult type
\n

OperationResultOutput

\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
NameType
volatilestring
permanentstring
dialogstring
inlinestring
\n

OperationResultType

\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
NameType
criticalstring
errorstring
warningstring
successstring
unauthorizedstring
\n

OperationError

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
errorstringThe error message.
","headings":[{"value":"Configuration","depth":1},{"value":"Parameters","depth":2},{"value":"Responses","depth":2},{"value":"Success 200","depth":3},{"value":"Error 4xx","depth":3},{"value":"Examples","depth":2},{"value":"Get the elements config by type from the tree view of the processes facet","depth":3},{"value":"Request","depth":4},{"value":"Response (200 OK)","depth":4},{"value":"Get the elements config from the tree view of the processes facet","depth":3},{"value":"Request","depth":4},{"value":"Response (200 OK)","depth":4},{"value":"Get the configuration of the process graphic","depth":3},{"value":"Request","depth":4},{"value":"Reponse (200 OK)","depth":4},{"value":"Definitions","depth":2},{"value":"ElementType","depth":3},{"value":"OperationResult","depth":3},{"value":"OperationResultOutput","depth":3},{"value":"OperationResultType","depth":3},{"value":"OperationError","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":"3a09e7fc-425a-5580-9909-28b6fa34fc28__redocly content/cpm/developer/rest-api/reference/config/","seo":{"title":"Configuration","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/rest-api/reference/config.md","pageBaseUrl":"/cpm/developer/rest-api/reference/config","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Configuration","id":"configuration"},{"depth":2,"value":"Parameters","id":"parameters"},{"depth":2,"value":"Responses","id":"responses"},{"depth":3,"value":"Success 200","id":"success-200"},{"depth":3,"value":"Error 4xx","id":"error-4xx"},{"depth":2,"value":"Examples","id":"examples"},{"depth":3,"value":"Get the elements config by type from the tree view of the processes facet","id":"get-the-elements-config-by-type-from-the-tree-view-of-the-processes-facet"},{"depth":4,"value":"Request","id":"request"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok"},{"depth":3,"value":"Get the elements config from the tree view of the processes facet","id":"get-the-elements-config-from-the-tree-view-of-the-processes-facet"},{"depth":4,"value":"Request","id":"request-1"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok-1"},{"depth":3,"value":"Get the configuration of the process graphic","id":"get-the-configuration-of-the-process-graphic"},{"depth":4,"value":"Request","id":"request-2"},{"depth":4,"value":"Reponse (200 OK)","id":"reponse-200-ok"},{"depth":2,"value":"Definitions","id":"definitions"},{"depth":3,"value":"ElementType","id":"elementtype"},{"depth":3,"value":"OperationResult","id":"operationresult"},{"depth":3,"value":"OperationResultOutput","id":"operationresultoutput"},{"depth":3,"value":"OperationResultType","id":"operationresulttype"},{"depth":3,"value":"OperationError","id":"operationerror"}]},"data":{"title":""},"catalogInfo":null,"link":"/cpm/developer/rest-api/reference/config/","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"]}