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

Elements update

\n

api-version: 4.0

\n

Update existing element

\n
\n
\n
Copy
\n
Copied
\n
\n 
POST /{collectionId}/{storageId}/_api/rest/facets/{facetId}/views/{viewId}/elements/
\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
NameInRequiredTypeDescription
collectionIdpathtruestringThe ID of the storage collection.
storageIdpathtruestringThe ID of the tenant.
facetIdpathtruestringThe name of the facet.
viewIdpathtruestringThe name of the view.
\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.
valuesElementCollectionThe list of elements.
\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

Update existing element in the detail view of the processes facet

\n

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
POST https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements
\n
\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 1,\n    \"elements\": [\n        {\n            \"facetName\": \"processes\",\n            \"id\": \"a98a9d95-77d1-4d5d-9178-cf03f617c8df\",\n            \"versionId\": \"7a8660bc-3935-44dd-9c3c-98fbd7ca8425\",\n            \"type\": \"subProcess\",\n            \"state\": \"inProcess\",\n            \"displayNames\": {\n            \"1031\": \"Sub Process\",\n            \"1033\": \"sub process\"\n            },\n            \"attributes\": {\n                \"changedOn\": {\n                    \"127\": \"2019-05-22T11:12:36\"\n                },\n                \"createdOn\": {\n                    \"127\": \"2019-05-22T10:08:29\"\n                },\n                \"gotoUrl\": {\n                    \"1031\": \"https://demo.symbioworld.com/pz/showcase/1031/BasePlugin/GoTo/Processes/treeanddiagram/7a8660bc-3935-44dd-9c3c-98fbd7ca8425\",\n                    \"1033\": \"https://demo.symbioworld.com/pz/showcase/1033/BasePlugin/GoTo/Processes/treeanddiagram/7a8660bc-3935-44dd-9c3c-98fbd7ca8425\"\n                },\n                \"isReleased\": {\n                    \"127\": false\n                },\n                \"name\": {\n                    \"1031\": \"SubProcess\",\n                    \"1033\": \"SubProcess\"\n                },\n                \"state1\": {\n                    \"127\": \"inProcess\"\n                },\n                \"validUntil\": {\n                    \"127\": \"9999-12-31T00:00:00\"\n                },\n                \"version\": {\n                    \"127\": \"0.1\"\n                }\n            },\n            \"related\": {\n                \"author\": [\n                    {\n                        \"facetName\": \"users\",\n                        \"id\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                        \"creationId\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                        \"type\": \"user\",\n                        \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views/detail/elements/a364f30b-a126-4a74-9e1a-1df87f2a6074\"\n                    }\n                ],\n                \"changedBy\": [\n                    {\n                        \"facetName\": \"users\",\n                        \"id\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                        \"creationId\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                        \"type\": \"user\",\n                        \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views/detail/elements/a364f30b-a126-4a74-9e1a-1df87f2a6074\"\n                    }\n                ],\n                \"createdBy\": [\n                    {\n                        \"facetName\": \"users\",\n                        \"id\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                        \"creationId\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                        \"type\": \"user\",\n                        \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views/detail/elements/a364f30b-a126-4a74-9e1a-1df87f2a6074\"\n                    }\n                ],\n                \"owner\": [\n                    {\n                        \"facetName\": \"users\",\n                        \"id\": \"0630c057-6ba7-47fd-a72f-c9bb80bf18b1\",\n                        \"creationId\": \"0630c057-6ba7-47fd-a72f-c9bb80bf18b1\",\n                        \"type\": \"user\",\n                        \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views/detail/elements/0630c057-6ba7-47fd-a72f-c9bb80bf18b1\"\n                    }\n                ]\n            },\n            \"content\": [\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"9807501f-e1da-41cf-9c31-91e4fa38be43\",\n                    \"creationId\": \"9807501f-e1da-41cf-9c31-91e4fa38be43\",\n                    \"type\": \"evEnd\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/9807501f-e1da-41cf-9c31-91e4fa38be43\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"365732dc-12a9-4405-b461-5472b088c0b6\",\n                    \"creationId\": \"365732dc-12a9-4405-b461-5472b088c0b6\",\n                    \"type\": \"evStart\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/365732dc-12a9-4405-b461-5472b088c0b6\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"499eda4c-5b1a-4305-a229-abd81ac90cdd\",\n                    \"creationId\": \"499eda4c-5b1a-4305-a229-abd81ac90cdd\",\n                    \"type\": \"processInterfacePlaceholder\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/499eda4c-5b1a-4305-a229-abd81ac90cdd\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"1a4dad34-eecd-4ebb-a7e4-25a21a5efa3c\",\n                    \"versionId\": \"fb92ff40-a84b-4879-bce0-0aa24982f23e\",\n                    \"type\": \"subProcess\",\n                    \"state\": \"inProcess\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/fb92ff40-a84b-4879-bce0-0aa24982f23e\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"9945eda5-abbc-4e40-8b44-d29f37d7146a\",\n                    \"creationId\": \"9945eda5-abbc-4e40-8b44-d29f37d7146a\",\n                    \"type\": \"evEnd\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/9945eda5-abbc-4e40-8b44-d29f37d7146a\"\n                }\n            ]\n        }\n    ]\n}
\n
\n

Response (200 OK)

\n
\n

some

"\n },\n "state1": {\n "127": "inProcess"\n },\n "validFrom": {\n "127": "2019-05-22T00:00:00"\n },\n "validUntil": {\n "127": "9999-12-31T00:00:00"\n },\n "version": {\n "127": "0.1"\n }\n },\n "related": {\n "author": [\n {\n "facetName": "users",\n "id": "a364f30b-a126-4a74-9e1a-1df87f2a6074",\n "creationId": "a364f30b-a126-4a74-9e1a-1df87f2a6074",\n "type": "user",\n "expandUri": "https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views/detail/elements/a364f30b-a126-4a74-9e1a-1df87f2a6074"\n }\n ],\n "changedBy": [\n {\n "facetName": "automation",\n "id": "65bc9c65-da32-4d81-ba9f-898a9e09dd91",\n "creationId": "65bc9c65-da32-4d81-ba9f-898a9e09dd91",\n "type": "authToken",\n "expandUri": "https://demo.symbioworld.com/pz/showcase/_api/rest/facets/automation/views/detail/elements/65bc9c65-da32-4d81-ba9f-898a9e09dd91"\n }\n ],\n "createdBy": [\n {\n "facetName": "users",\n "id": "a364f30b-a126-4a74-9e1a-1df87f2a6074",\n "creationId": "a364f30b-a126-4a74-9e1a-1df87f2a6074",\n "type": "user",\n "expandUri": "https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views/detail/elements/a364f30b-a126-4a74-9e1a-1df87f2a6074"\n }\n ],\n "owner": [\n {\n "facetName": "users",\n "id": "0630c057-6ba7-47fd-a72f-c9bb80bf18b1",\n "creationId": "0630c057-6ba7-47fd-a72f-c9bb80bf18b1",\n "type": "user",\n "expandUri": "https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views/detail/elements/0630c057-6ba7-47fd-a72f-c9bb80bf18b1"\n }\n ]\n },\n "content": [\n {\n "facetName": "processes",\n "id": "1a4dad34-eecd-4ebb-a7e4-25a21a5efa3c",\n "versionId": "fb92ff40-a84b-4879-bce0-0aa24982f23e",\n "type": "subProcess",\n "state": "inProcess",\n "expandUri": "https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/fb92ff40-a84b-4879-bce0-0aa24982f23e"\n },\n {\n "facetName": "processes",\n "id": "365732dc-12a9-4405-b461-5472b088c0b6",\n "creationId": "365732dc-12a9-4405-b461-5472b088c0b6",\n "type": "evStart",\n "expandUri": "https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/365732dc-12a9-4405-b461-5472b088c0b6"\n },\n {\n "facetName": "processes",\n "id": "9807501f-e1da-41cf-9c31-91e4fa38be43",\n "creationId": "9807501f-e1da-41cf-9c31-91e4fa38be43",\n "type": "evEnd",\n "expandUri": "https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/9807501f-e1da-41cf-9c31-91e4fa38be43"\n },\n {\n "facetName": "processes",\n "id": "499eda4c-5b1a-4305-a229-abd81ac90cdd",\n "creationId": "499eda4c-5b1a-4305-a229-abd81ac90cdd",\n "type": "processInterfacePlaceholder",\n "expandUri": "https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/499eda4c-5b1a-4305-a229-abd81ac90cdd"\n },\n {\n "facetName": "processes",\n "id": "9945eda5-abbc-4e40-8b44-d29f37d7146a",\n "creationId": "9945eda5-abbc-4e40-8b44-d29f37d7146a",\n "type": "evEnd",\n "expandUri": "https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/9945eda5-abbc-4e40-8b44-d29f37d7146a"\n }\n ]\n }\n ]\n}`, `31354576618431970000`)\"\n >\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 1,\n    \"elements\": [\n        {\n            \"facetName\": \"processes\",\n            \"id\": \"a98a9d95-77d1-4d5d-9178-cf03f617c8df\",\n            \"versionId\": \"7a8660bc-3935-44dd-9c3c-98fbd7ca8425\",\n            \"type\": \"subProcess\",\n            \"state\": \"inProcess\",\n            \"displayNames\": {\n            \"1031\": \"Sub Process\",\n            \"1033\": \"sub process\"\n            },\n            \"attributes\": {\n                \"authorNote\": {\n                    \"1031\": \"Ein oder mehrere Autoren wurden gesetzt. Nur Architekten und die angegebenen Autoren dürfen das aktuelle Element bearbeiten.\",\n                    \"1033\": \"The author was set. Only architects and the defined authors are allowed to edit the current element.\"\n                },\n                \"changedOn\": {\n                    \"127\": \"2019-05-22T15:08:50.1189714\"\n                },\n                \"createdOn\": {\n                    \"127\": \"2019-05-22T10:08:29\"\n                },\n                \"gotoUrl\": {\n                    \"1031\": \"https://demo.symbioworld.com/pz/showcase/1031/BasePlugin/GoTo/Processes/treeanddiagram/7a8660bc-3935-44dd-9c3c-98fbd7ca8425\",\n                    \"1033\": \"https://demo.symbioworld.com/pz/showcase/1033/BasePlugin/GoTo/Processes/treeanddiagram/7a8660bc-3935-44dd-9c3c-98fbd7ca8425\"\n                },\n                \"isReleased\": {\n                    \"127\": false\n                },\n                \"name\": {\n                    \"1031\": \"SubProcess\",\n                    \"1033\": \"SubProcess\"\n                },\n                \"reasonForRevision\": {\n                    \"127\": \"<?xml version=\\\"1.0\\\" encoding=\\\"utf-8\\\"?><p>some</p>\"\n                },\n                \"state1\": {\n                    \"127\": \"inProcess\"\n                },\n                \"validFrom\": {\n                    \"127\": \"2019-05-22T00:00:00\"\n                },\n                \"validUntil\": {\n                    \"127\": \"9999-12-31T00:00:00\"\n                },\n                \"version\": {\n                    \"127\": \"0.1\"\n                }\n            },\n            \"related\": {\n                \"author\": [\n                    {\n                        \"facetName\": \"users\",\n                        \"id\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                        \"creationId\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                        \"type\": \"user\",\n                        \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views/detail/elements/a364f30b-a126-4a74-9e1a-1df87f2a6074\"\n                    }\n                ],\n                \"changedBy\": [\n                    {\n                        \"facetName\": \"automation\",\n                        \"id\": \"65bc9c65-da32-4d81-ba9f-898a9e09dd91\",\n                        \"creationId\": \"65bc9c65-da32-4d81-ba9f-898a9e09dd91\",\n                        \"type\": \"authToken\",\n                        \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/automation/views/detail/elements/65bc9c65-da32-4d81-ba9f-898a9e09dd91\"\n                    }\n                ],\n                \"createdBy\": [\n                    {\n                        \"facetName\": \"users\",\n                        \"id\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                        \"creationId\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                        \"type\": \"user\",\n                        \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views/detail/elements/a364f30b-a126-4a74-9e1a-1df87f2a6074\"\n                    }\n                ],\n                \"owner\": [\n                    {\n                        \"facetName\": \"users\",\n                        \"id\": \"0630c057-6ba7-47fd-a72f-c9bb80bf18b1\",\n                        \"creationId\": \"0630c057-6ba7-47fd-a72f-c9bb80bf18b1\",\n                        \"type\": \"user\",\n                        \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views/detail/elements/0630c057-6ba7-47fd-a72f-c9bb80bf18b1\"\n                    }\n                ]\n            },\n            \"content\": [\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"1a4dad34-eecd-4ebb-a7e4-25a21a5efa3c\",\n                    \"versionId\": \"fb92ff40-a84b-4879-bce0-0aa24982f23e\",\n                    \"type\": \"subProcess\",\n                    \"state\": \"inProcess\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/fb92ff40-a84b-4879-bce0-0aa24982f23e\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"365732dc-12a9-4405-b461-5472b088c0b6\",\n                    \"creationId\": \"365732dc-12a9-4405-b461-5472b088c0b6\",\n                    \"type\": \"evStart\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/365732dc-12a9-4405-b461-5472b088c0b6\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"9807501f-e1da-41cf-9c31-91e4fa38be43\",\n                    \"creationId\": \"9807501f-e1da-41cf-9c31-91e4fa38be43\",\n                    \"type\": \"evEnd\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/9807501f-e1da-41cf-9c31-91e4fa38be43\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"499eda4c-5b1a-4305-a229-abd81ac90cdd\",\n                    \"creationId\": \"499eda4c-5b1a-4305-a229-abd81ac90cdd\",\n                    \"type\": \"processInterfacePlaceholder\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/499eda4c-5b1a-4305-a229-abd81ac90cdd\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"9945eda5-abbc-4e40-8b44-d29f37d7146a\",\n                    \"creationId\": \"9945eda5-abbc-4e40-8b44-d29f37d7146a\",\n                    \"type\": \"evEnd\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/9945eda5-abbc-4e40-8b44-d29f37d7146a\"\n                }\n            ]\n        }\n    ]\n}
\n
\n

Definitions

\n

Element

\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\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
NameTypeDescription
idGuid?The identifier of the element.
versionIdGuid?The identifier of the specific version.
statestringThe current state of the element.
stereotypestringThe stereotype of the element.
typestringThe type of the element.
attributesDictionary<string, Dictionary<int, object>>The attributes of the element.
relatedDictionary<string, List<Element>>The list of related elements.
childrenElementThe list of child elements.
contentElementThe list of content elements.
rootPathElementThe list of hierarchical parent elements to the root element.
displayNamesDictionary<int, string>Gets the display names of multiple languages.
expandUristringGets or sets the expand Uri to get full information about element
facetNamestringName of the facet
setReadOnlybool?Gets or sets the read only of the element
versionsElementElement versions of this container
\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":"Elements update","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":"Update existing element in the detail view of the processes facet","depth":3},{"value":"Request","depth":4},{"value":"Response (200 OK)","depth":4},{"value":"Definitions","depth":2},{"value":"Element","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":"5e547880-b35d-5d15-a05d-0af598914750__redocly content/cpm/developer/rest-api/reference/elements-update/","seo":{"title":"Elements update","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/rest-api/reference/elements-update.md","pageBaseUrl":"/cpm/developer/rest-api/reference/elements-update","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Elements update","id":"elements-update"},{"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":"Update existing element in the detail view of the processes facet","id":"update-existing-element-in-the-detail-view-of-the-processes-facet"},{"depth":4,"value":"Request","id":"request"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok"},{"depth":2,"value":"Definitions","id":"definitions"},{"depth":3,"value":"Element","id":"element"},{"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/elements-update/","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"]}