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

Related get

\n

api-version: 1.0

\n

Retrieves a specific related contexts.

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET /{collectionId}/{storageId}/_api/rest/facets/{facetId}/views/{viewId}/elements/{elementId}/related/{relatedId}
\n
\n

With optional parameters

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET /{collectionId}/{storageId}/_api/rest/facets/{facetId}/views/{viewId}/elements/{elementId}/related?$filter={filter}&$expandRelated={expand}
\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\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.
elementIdpathtruestringThe ID of the element.
relatedIdpathtruestringThe name of the related context.
$filterquerystring
$expandRelatedquerystringA comma separated list of names of the related contexts to expand.
\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 related 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

Get the author related context of an element

\n

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
POST https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/f4f3943d-6b3b-42a9-8a3a-30acf42ce7d5/related/author
\n
\n

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 1,\n    \"values\": {\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    }\n}
\n
\n

Get and expand the author related contexts of an element

\n

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
POST https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/f4f3943d-6b3b-42a9-8a3a-30acf42ce7d5/related/author?$expandRelated=author
\n
\n

Response (200 OK)

\n
\n

Deutsch

",\n "1033": "

German

"\n },\n "isAvailableForReporting": {\n "127": true\n },\n "lcid": {\n "127": "1031"\n },\n "name": {\n "1031": "Deutsch",\n "1033": "German"\n }\n }\n }\n ],\n "hasSecondaryCultures": [\n {\n "facetName": "cultures",\n "id": "8EB0D08D-B332-4E02-A9F4-12F76AEB696C",\n "creationId": "8EB0D08D-B332-4E02-A9F4-12F76AEB696C",\n "type": "configCulture",\n "attributes": {\n "cultureIsDefault": {\n "127": true\n },\n "description": {\n "1031": "

Englisch

",\n "1033": "

English

"\n },\n "isAvailableForReporting": {\n "127": true\n },\n "lcid": {\n "127": "1033"\n },\n "name": {\n "1031": "Englisch",\n "1033": "English"\n }\n }\n }\n ],\n "userGroups": [\n {\n "facetName": "usergroups",\n "id": "3cb8366f-3424-4e36-ad6e-03ae72d38191",\n "creationId": "3cb8366f-3424-4e36-ad6e-03ae72d38191",\n "type": "userGroup",\n "attributes": {\n "id": {\n "127": "GrpProjectAccess"\n },\n "name": {\n "1031": "GrpProjectAccess",\n "1033": "GrpProjectAccess"\n }\n }\n },\n {\n "facetName": "usergroups",\n "id": "1fe01960-8f0c-4423-928a-30782efd083d",\n "creationId": "1fe01960-8f0c-4423-928a-30782efd083d",\n "type": "userGroup",\n "attributes": {\n "id": {\n "127": "GrpProjectX1"\n },\n "name": {\n "1031": "GrpProjectX1",\n "1033": "GrpProjectX1"\n }\n }\n },\n {\n "facetName": "usergroups",\n "id": "284E0050-25E8-464D-A321-5DA8234679D1",\n "creationId": "284E0050-25E8-464D-A321-5DA8234679D1",\n "type": "userGroup",\n "attributes": {\n "id": {\n "127": "AdminInfo"\n },\n "name": {\n "1031": "AdminInfo",\n "1033": "AdminInfo"\n }\n }\n },\n {\n "facetName": "usergroups",\n "id": "34b87d93-083a-48d0-8891-920ca6e51a3a",\n "creationId": "34b87d93-083a-48d0-8891-920ca6e51a3a",\n "type": "userGroup",\n "attributes": {\n "id": {\n "127": "GrpProjectX2"\n },\n "name": {\n "1031": "GrpProjectX2",\n "1033": "GrpProjectX2"\n }\n }\n },\n {\n "facetName": "usergroups",\n "id": "3c28b40f-7da8-4b70-8b05-0c3cc274833f",\n "creationId": "3c28b40f-7da8-4b70-8b05-0c3cc274833f",\n "type": "userGroup",\n "attributes": {\n "id": {\n "127": "GrpManaging"\n },\n "name": {\n "1031": "GrpManaging",\n "1033": "GrpManaging"\n }\n }\n }\n ]\n }\n }\n ]\n }\n}`, `76634442863475690000`)\"\n >\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 1,\n    \"values\": {\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                \"related\": {\n                    \"changedBy\": [\n                        {\n                            \"facetName\": \"users\",\n                            \"id\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                            \"creationId\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                            \"type\": \"user\",\n                            \"attributes\": {\n                                \"changedOn\": {\n                                    \"127\": \"2019-04-25T14:48:22\"\n                                },\n                                \"createdOn\": {\n                                    \"127\": \"2016-06-13T09:11:49\"\n                                },\n                                \"filterInformation\": {\n                                    \"1031\": \"Keine Filter angewendet\",\n                                    \"1033\": \"No filter applied\"\n                                },\n                                \"firstName\": {\n                                    \"127\": \"Symbio\"\n                                },\n                                \"lastName\": {\n                                    \"127\": \"Administrator\"\n                                },\n                                \"roleAdministrator\": {\n                                    \"127\": true\n                                },\n                                \"roleAnalyzer\": {\n                                    \"127\": true\n                                },\n                                \"roleApprover\": {\n                                    \"127\": true\n                                },\n                                \"roleArchitect\": {\n                                    \"127\": true\n                                },\n                                \"roleEditor\": {\n                                    \"127\": true\n                                },\n                                \"roleInactive\": {\n                                    \"127\": false\n                                },\n                                \"roleViewer\": {\n                                    \"127\": true\n                                },\n                                \"userFirstLogin\": {\n                                    \"127\": \"2018-04-06T12:09:08\"\n                                },\n                                \"userLastLogin\": {\n                                    \"127\": \"2019-04-25T14:48:22\"\n                                },\n                                \"userLoginCount\": {\n                                    \"127\": 445\n                                }\n                            }\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                            \"attributes\": {\n                                \"changedOn\": {\n                                    \"127\": \"2019-04-25T14:48:22\"\n                                },\n                                \"createdOn\": {\n                                    \"127\": \"2016-06-13T09:11:49\"\n                                },\n                                \"filterInformation\": {\n                                    \"1031\": \"Keine Filter angewendet\",\n                                    \"1033\": \"No filter applied\"\n                                },\n                                \"firstName\": {\n                                    \"127\": \"Symbio\"\n                                },\n                                \"lastName\": {\n                                    \"127\": \"Administrator\"\n                                },\n                                \"roleAdministrator\": {\n                                    \"127\": true\n                                },\n                                \"roleAnalyzer\": {\n                                    \"127\": true\n                                },\n                                \"roleApprover\": {\n                                    \"127\": true\n                                },\n                                \"roleArchitect\": {\n                                    \"127\": true\n                                },\n                                \"roleEditor\": {\n                                    \"127\": true\n                                },\n                                \"roleInactive\": {\n                                    \"127\": false\n                                },\n                                \"roleViewer\": {\n                                    \"127\": true\n                                },\n                                \"userFirstLogin\": {\n                                    \"127\": \"2018-04-06T12:09:08\"\n                                },\n                                \"userLastLogin\": {\n                                    \"127\": \"2019-04-25T14:48:22\"\n                                },\n                                \"userLoginCount\": {\n                                    \"127\": 445\n                                }\n                            }\n                        }\n                    ],\n                    \"hasCulture\": [\n                        {\n                            \"facetName\": \"cultures\",\n                            \"id\": \"A67E06B1-D942-44E4-B886-CF11931ED8B7\",\n                            \"creationId\": \"A67E06B1-D942-44E4-B886-CF11931ED8B7\",\n                            \"type\": \"configCulture\",\n                            \"attributes\": {\n                                \"description\": {\n                                    \"1031\": \"<?xml version=\\\"1.0\\\" encoding=\\\"utf-8\\\"?><p>Deutsch</p>\",\n                                    \"1033\": \"<?xml version=\\\"1.0\\\" encoding=\\\"utf-8\\\"?><p>German</p>\"\n                                },\n                                \"isAvailableForReporting\": {\n                                    \"127\": true\n                                },\n                                \"lcid\": {\n                                    \"127\": \"1031\"\n                                },\n                                \"name\": {\n                                    \"1031\": \"Deutsch\",\n                                    \"1033\": \"German\"\n                                }\n                            }\n                        }\n                    ],\n                    \"hasSecondaryCultures\": [\n                        {\n                            \"facetName\": \"cultures\",\n                            \"id\": \"8EB0D08D-B332-4E02-A9F4-12F76AEB696C\",\n                            \"creationId\": \"8EB0D08D-B332-4E02-A9F4-12F76AEB696C\",\n                            \"type\": \"configCulture\",\n                            \"attributes\": {\n                                \"cultureIsDefault\": {\n                                    \"127\": true\n                                },\n                                \"description\": {\n                                    \"1031\": \"<?xml version=\\\"1.0\\\" encoding=\\\"utf-8\\\"?><p>Englisch</p>\",\n                                    \"1033\": \"<?xml version=\\\"1.0\\\" encoding=\\\"utf-8\\\"?><p>English</p>\"\n                                },\n                                \"isAvailableForReporting\": {\n                                    \"127\": true\n                                },\n                                \"lcid\": {\n                                    \"127\": \"1033\"\n                                },\n                                \"name\": {\n                                    \"1031\": \"Englisch\",\n                                    \"1033\": \"English\"\n                                }\n                            }\n                        }\n                    ],\n                    \"userGroups\": [\n                        {\n                            \"facetName\": \"usergroups\",\n                            \"id\": \"3cb8366f-3424-4e36-ad6e-03ae72d38191\",\n                            \"creationId\": \"3cb8366f-3424-4e36-ad6e-03ae72d38191\",\n                            \"type\": \"userGroup\",\n                            \"attributes\": {\n                                \"id\": {\n                                    \"127\": \"GrpProjectAccess\"\n                                },\n                                \"name\": {\n                                    \"1031\": \"GrpProjectAccess\",\n                                    \"1033\": \"GrpProjectAccess\"\n                                }\n                            }\n                        },\n                        {\n                            \"facetName\": \"usergroups\",\n                            \"id\": \"1fe01960-8f0c-4423-928a-30782efd083d\",\n                            \"creationId\": \"1fe01960-8f0c-4423-928a-30782efd083d\",\n                            \"type\": \"userGroup\",\n                            \"attributes\": {\n                                \"id\": {\n                                    \"127\": \"GrpProjectX1\"\n                                },\n                                \"name\": {\n                                    \"1031\": \"GrpProjectX1\",\n                                    \"1033\": \"GrpProjectX1\"\n                                }\n                            }\n                        },\n                        {\n                            \"facetName\": \"usergroups\",\n                            \"id\": \"284E0050-25E8-464D-A321-5DA8234679D1\",\n                            \"creationId\": \"284E0050-25E8-464D-A321-5DA8234679D1\",\n                            \"type\": \"userGroup\",\n                            \"attributes\": {\n                                \"id\": {\n                                    \"127\": \"AdminInfo\"\n                                },\n                                \"name\": {\n                                    \"1031\": \"AdminInfo\",\n                                    \"1033\": \"AdminInfo\"\n                                }\n                            }\n                        },\n                        {\n                            \"facetName\": \"usergroups\",\n                            \"id\": \"34b87d93-083a-48d0-8891-920ca6e51a3a\",\n                            \"creationId\": \"34b87d93-083a-48d0-8891-920ca6e51a3a\",\n                            \"type\": \"userGroup\",\n                            \"attributes\": {\n                                \"id\": {\n                                    \"127\": \"GrpProjectX2\"\n                                },\n                                \"name\": {\n                                    \"1031\": \"GrpProjectX2\",\n                                    \"1033\": \"GrpProjectX2\"\n                                }\n                            }\n                        },\n                        {\n                            \"facetName\": \"usergroups\",\n                            \"id\": \"3c28b40f-7da8-4b70-8b05-0c3cc274833f\",\n                            \"creationId\": \"3c28b40f-7da8-4b70-8b05-0c3cc274833f\",\n                            \"type\": \"userGroup\",\n                            \"attributes\": {\n                                \"id\": {\n                                    \"127\": \"GrpManaging\"\n                                },\n                                \"name\": {\n                                    \"1031\": \"GrpManaging\",\n                                    \"1033\": \"GrpManaging\"\n                                }\n                            }\n                        }\n                    ]\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":"Related get","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 author related context of an element","depth":3},{"value":"Request","depth":4},{"value":"Response (200 OK)","depth":4},{"value":"Get and expand the author related contexts of an element","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":"d574ade6-54cc-570a-b213-46fc5f183ee9__redocly content/cpm/developer/rest-api/reference/related-get/","seo":{"title":"Related get","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/rest-api/reference/related-get.md","pageBaseUrl":"/cpm/developer/rest-api/reference/related-get","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Related get","id":"related-get"},{"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 author related context of an element","id":"get-the-author-related-context-of-an-element"},{"depth":4,"value":"Request","id":"request"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok"},{"depth":3,"value":"Get and expand the author related contexts of an element","id":"get-and-expand-the-author-related-contexts-of-an-element"},{"depth":4,"value":"Request","id":"request-1"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok-1"},{"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/related-get/","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"]}