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

Change state

\n

api-version: 4.0

\n

Change the state of a specific element.

\n
\n
\n
Copy
\n
Copied
\n
\n 
POST /{collectionId}/{storageId}/_api/release/{elementId}/transitions/{transitionId}
\n
\n

With optional parameters

\n
\n
\n
Copy
\n
Copied
\n
\n 
POST /{collectionId}/{storageId}/_api/release/{elementId}/transitions/{transitionId}?ignoreWarnings={ignoreWarnings}
\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.
elementIdpathtruestringThe ID of the element.
transitionIdpathtruestringThe ID of the transition.
ignoreWarningspathtrueboolean [true, false]Ignore validation warnings.
\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

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
POST https://demo.symbioworld.com/pz/showcase/_api/rest/release/664fd624-d341-4521-b430-897bb16399f4/transitions/ReleasedToRequestToExpire
\n
\n

Response (200 OK)

\n
\n

need to be released

"\n },\n "relOn": {\n "127": "2019-05-22T12:03:54.8308905"\n },\n "state1": {\n "127": "released"\n },\n "validFrom": {\n "127": "2019-05-22T00:00:00"\n },\n "validUntil": {\n "127": "9999-12-31T00:00:00"\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": "7a827f97-b970-49fd-97bf-02ecda1b3cfb",\n "creationId": "7a827f97-b970-49fd-97bf-02ecda1b3cfb",\n "type": "authToken",\n "expandUri": "https://demo.symbioworld.com/pz/showcase/_api/rest/facets/automation/views/detail/elements/7a827f97-b970-49fd-97bf-02ecda1b3cfb"\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": "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 "qualityManager": [\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 "relBy": [\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 "releaseHistory": [\n {\n "facetName": "processes",\n "id": "096724b9-5cab-4ff0-890d-69ea65ac6de7",\n "versionId": "40045b2b-413c-4289-a919-11f89af037fb",\n "type": "subProcess",\n "state": "released",\n "expandUri": "https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/40045b2b-413c-4289-a919-11f89af037fb"\n }\n ],\n "reviewer": [\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 "secondaryAuthors": [\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 }\n }\n ]\n}`, `85288843217721330000`)\"\n >\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 1,\n    \"elements\": [\n        {\n            \"facetName\": \"processes\",\n            \"id\": \"096724b9-5cab-4ff0-890d-69ea65ac6de7\",\n            \"versionId\": \"40045b2b-413c-4289-a919-11f89af037fb\",\n            \"type\": \"subProcess\",\n            \"state\": \"released\",\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-22T12:04:14.9195116\"\n                },\n                \"createdOn\": {\n                    \"127\": \"2019-05-22T11:57:32\"\n                },\n                \"name\": {\n                    \"1031\": \"SubProcess\",\n                    \"1033\": \"SubProcess\"\n                },\n                \"reasonForRevision\": {\n                    \"127\": \"<?xml version=\\\"1.0\\\" encoding=\\\"utf-8\\\"?><p>need to be released</p>\"\n                },\n                \"relOn\": {\n                    \"127\": \"2019-05-22T12:03:54.8308905\"\n                },\n                \"state1\": {\n                    \"127\": \"released\"\n                },\n                \"validFrom\": {\n                    \"127\": \"2019-05-22T00:00:00\"\n                },\n                \"validUntil\": {\n                    \"127\": \"9999-12-31T00:00:00\"\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\": \"7a827f97-b970-49fd-97bf-02ecda1b3cfb\",\n                        \"creationId\": \"7a827f97-b970-49fd-97bf-02ecda1b3cfb\",\n                        \"type\": \"authToken\",\n                        \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/automation/views/detail/elements/7a827f97-b970-49fd-97bf-02ecda1b3cfb\"\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\": \"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                \"qualityManager\": [\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                \"relBy\": [\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                \"releaseHistory\": [\n                    {\n                        \"facetName\": \"processes\",\n                        \"id\": \"096724b9-5cab-4ff0-890d-69ea65ac6de7\",\n                        \"versionId\": \"40045b2b-413c-4289-a919-11f89af037fb\",\n                        \"type\": \"subProcess\",\n                        \"state\": \"released\",\n                        \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/40045b2b-413c-4289-a919-11f89af037fb\"\n                    }\n                ],\n                \"reviewer\": [\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                \"secondaryAuthors\": [\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            }\n        }\n    ]\n}
\n
\n

!!! info\nAfter successfully \"ReleasedToRequestToExpire\" transition for Sub Process, new task will appear in header \"My tasks(1)\". It will be added new \"Approve expiry\" action type that must be accepted to complete the transition.

\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":"Change state","depth":1},{"value":"Parameters","depth":2},{"value":"Responses","depth":2},{"value":"Success 200","depth":3},{"value":"Error 4xx","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":"79e6005f-266c-5f03-b512-5089d40a5caf__redocly content/cpm/developer/rest-api/reference/release-change-state/","seo":{"title":"Change state","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/rest-api/reference/release-change-state.md","pageBaseUrl":"/cpm/developer/rest-api/reference/release-change-state","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Change state","id":"change-state"},{"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":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/release-change-state/","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"]}