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

Related list

\n

api-version: 1.0

\n

Retrieves the list of related contexts.

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET /{collectionId}/{storageId}/_api/rest/facets/{facetId}/views/{viewId}/elements/{elementId}/related
\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}&$select={select}&$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.
$filterquerystring
$selectquerystringA comma separated list of namesof the attributes/related contexts to include.
$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 list of related contexts of an element

\n

Request

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

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 18,\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        \"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        \"guidelines\": [\n            {\n                \"facetName\": \"knowledge\",\n                \"id\": \"d33bdbe6-07c1-47c4-915d-00b02454631f\",\n                \"versionId\": \"c337213a-7585-48a9-9eb2-cff2f9560011\",\n                \"type\": \"knowledgeStructureDocument\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/knowledge/views/detail/elements/c337213a-7585-48a9-9eb2-cff2f9560011\"\n            },\n            {\n                \"facetName\": \"knowledge\",\n                \"id\": \"b794e6f3-f61e-43f1-8e76-865686c81f43\",\n                \"versionId\": \"0da36332-3ae6-4127-9fb6-6853dbb7245b\",\n                \"type\": \"knowledgeStructureDocument\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/knowledge/views/detail/elements/0da36332-3ae6-4127-9fb6-6853dbb7245b\"\n            }\n        ],\n        \"hasInput\": [\n            {\n                \"facetName\": \"inputsoutputs\",\n                \"id\": \"22fe4a97-1b06-41b8-9e6d-9fe065f8a91d\",\n                \"versionId\": \"d23564c5-567b-4439-940e-0efe9b140229\",\n                \"type\": \"inOut\",\n                \"state\": \"released\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/inputsoutputs/views/detail/elements/d23564c5-567b-4439-940e-0efe9b140229\"\n            },\n            {\n                \"facetName\": \"inputsoutputs\",\n                \"id\": \"b0c55ebe-fa0d-436a-aae7-15d9caa1e741\",\n                \"versionId\": \"15dcc40d-fb65-494f-9d00-8c537f408347\",\n                \"type\": \"inOut\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/inputsoutputs/views/detail/elements/15dcc40d-fb65-494f-9d00-8c537f408347\"\n            },\n            {\n                \"facetName\": \"inputsoutputs\",\n                \"id\": \"032a3501-4679-4cce-abc6-788394729bf9\",\n                \"versionId\": \"3887b540-3670-4f7a-b0b9-c4de9a5e004e\",\n                \"type\": \"inOut\",\n                \"state\": \"released\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/inputsoutputs/views/detail/elements/3887b540-3670-4f7a-b0b9-c4de9a5e004e\"\n            },\n            {\n                \"facetName\": \"inputsoutputs\",\n                \"id\": \"950f37ab-cb50-4cb9-ba3b-660f9fca8be1\",\n                \"versionId\": \"2b251a32-afd8-4140-8406-9bf700189f33\",\n                \"type\": \"inOut\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/inputsoutputs/views/detail/elements/2b251a32-afd8-4140-8406-9bf700189f33\"\n            },\n            {\n                \"facetName\": \"inputsoutputs\",\n                \"id\": \"554cc9dc-3794-4bf2-992d-98e5ec26b13c\",\n                \"versionId\": \"f6abd383-6a10-4470-b031-99df5748f4d0\",\n                \"type\": \"inOut\",\n                \"state\": \"released\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/inputsoutputs/views/detail/elements/f6abd383-6a10-4470-b031-99df5748f4d0\"\n            }\n        ],\n        \"hasOutput\": [\n            {\n                \"facetName\": \"inputsoutputs\",\n                \"id\": \"b1a6b1d1-f732-4aae-bffa-a196854f0aa6\",\n                \"versionId\": \"dd5eced4-9771-414f-a8b6-ffd29523d041\",\n                \"type\": \"inOut\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/inputsoutputs/views/detail/elements/dd5eced4-9771-414f-a8b6-ffd29523d041\"\n            },\n            {\n                \"facetName\": \"inputsoutputs\",\n                \"id\": \"36d5f4b4-ca8b-481d-83cc-5c7c780c5018\",\n                \"versionId\": \"ca7723e3-9c8d-4ac0-b2fd-6c4debe9f41b\",\n                \"type\": \"inOut\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/inputsoutputs/views/detail/elements/ca7723e3-9c8d-4ac0-b2fd-6c4debe9f41b\"\n            },\n            {\n                \"facetName\": \"inputsoutputs\",\n                \"id\": \"980d2829-4479-43c1-8e7d-d91c9a56173b\",\n                \"versionId\": \"b5d63e65-6343-42fd-af6f-7d12ee3dc13d\",\n                \"type\": \"inOut\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/inputsoutputs/views/detail/elements/b5d63e65-6343-42fd-af6f-7d12ee3dc13d\"\n            },\n            {\n                \"facetName\": \"inputsoutputs\",\n                \"id\": \"70bd7fde-7309-4051-9a17-a9a89d2bf7b9\",\n                \"versionId\": \"09a59ddd-3e82-4fdc-a7af-12a5aad0d1e3\",\n                \"type\": \"inOut\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/inputsoutputs/views/detail/elements/09a59ddd-3e82-4fdc-a7af-12a5aad0d1e3\"\n            },\n            {\n                \"facetName\": \"inputsoutputs\",\n                \"id\": \"b7e40edb-c364-47b9-aa5c-d0dd054a8138\",\n                \"versionId\": \"ac167362-c4c2-4407-a423-00c43e0a7069\",\n                \"type\": \"inOut\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/inputsoutputs/views/detail/elements/ac167362-c4c2-4407-a423-00c43e0a7069\"\n            },\n            {\n                \"facetName\": \"inputsoutputs\",\n                \"id\": \"a96a5423-887d-4fd5-bc68-1c4fd339856e\",\n                \"versionId\": \"47deb046-fe43-4d1f-a34d-9cbfa75c1fd6\",\n                \"type\": \"inOut\",\n                \"state\": \"released\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/inputsoutputs/views/detail/elements/47deb046-fe43-4d1f-a34d-9cbfa75c1fd6\"\n            }\n        ],\n        \"kpi\": [\n            {\n                \"facetName\": \"kpi\",\n                \"id\": \"6e8d574e-91a4-4ba6-a3fa-ea717b67329c\",\n                \"versionId\": \"90955400-f199-11df-2459-ccb6a833f624\",\n                \"type\": \"kPI\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/kpi/views/detail/elements/90955400-f199-11df-2459-ccb6a833f624\"\n            },\n            {\n                \"facetName\": \"kpi\",\n                \"id\": \"35274324-e3ad-4bd3-aaa3-543329de231f\",\n                \"versionId\": \"657ab3f7-165b-4dc5-9821-52ef417061eb\",\n                \"type\": \"kPI\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/kpi/views/detail/elements/657ab3f7-165b-4dc5-9821-52ef417061eb\"\n            }\n        ],\n        \"organizationFilters\": [\n            {\n                \"facetName\": \"organization\",\n                \"id\": \"43320ec1-1d8b-46b8-93e1-037a2d61d208\",\n                \"versionId\": \"171fe695-8776-49fc-9fda-ac37a1728299\",\n                \"type\": \"orgUnit\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/organization/views/detail/elements/171fe695-8776-49fc-9fda-ac37a1728299\",\n                \"stereotype\": \"division\"\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        \"qualityManager\": [\n            {\n                \"facetName\": \"users\",\n                \"id\": \"45b86897-4509-4db3-953f-bf4998f86f4d\",\n                \"creationId\": \"45b86897-4509-4db3-953f-bf4998f86f4d\",\n                \"type\": \"user\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views/detail/elements/45b86897-4509-4db3-953f-bf4998f86f4d\"\n            }\n        ],\n        \"releaseHistory\": [\n            {\n                \"facetName\": \"processes\",\n                \"id\": \"49f82ee7-9fe0-4ab1-86ed-0e6c13091dc7\",\n                \"versionId\": \"9fe36070-f0c0-11df-4e21-001c25729284\",\n                \"type\": \"subProcess\",\n                \"state\": \"expired\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/9fe36070-f0c0-11df-4e21-001c25729284\"\n            },\n            {\n                \"facetName\": \"processes\",\n                \"id\": \"49f82ee7-9fe0-4ab1-86ed-0e6c13091dc7\",\n                \"versionId\": \"168c8bc4-779e-4697-8334-0026411d52f1\",\n                \"type\": \"subProcess\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/168c8bc4-779e-4697-8334-0026411d52f1\"\n            }\n        ],\n        \"requirements\": [\n            {\n                \"facetName\": \"requirements\",\n                \"id\": \"19b1188a-6cf8-465b-acc1-1e9134a20b77\",\n                \"versionId\": \"414e448d-6e0e-4db2-9c7f-7c3e3fd37b0b\",\n                \"type\": \"requirement\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/requirements/views/detail/elements/414e448d-6e0e-4db2-9c7f-7c3e3fd37b0b\"\n            },\n            {\n                \"facetName\": \"requirements\",\n                \"id\": \"199c6546-fd51-40b6-a76b-1bbca4cd2bed\",\n                \"versionId\": \"1d5545cd-7d23-4d96-b89b-e44bf176623e\",\n                \"type\": \"requirement\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/requirements/views/detail/elements/1d5545cd-7d23-4d96-b89b-e44bf176623e\"\n            }\n        ],\n        \"risks\": [\n            {\n                \"facetName\": \"risks\",\n                \"id\": \"f23da386-726b-4938-b5c4-a7603a6c9e0b\",\n                \"versionId\": \"6076b42b-2ff5-4cb6-a353-9e996a368922\",\n                \"type\": \"risk\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/risks/views/detail/elements/6076b42b-2ff5-4cb6-a353-9e996a368922\"\n            }\n        ],\n        \"secondarySystemsInput\": [\n            {\n                \"facetName\": \"it\",\n                \"id\": \"732e54f3-063d-497b-9ec3-7e441eb3d531\",\n                \"versionId\": \"fb925a60-65f7-44de-bef1-e1a23b9cdd4e\",\n                \"type\": \"system\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/it/views/detail/elements/fb925a60-65f7-44de-bef1-e1a23b9cdd4e\",\n                \"stereotype\": \"applicationSystem\"\n            }\n        ],\n        \"secondarySystemsOutput\": [\n            {\n                \"facetName\": \"it\",\n                \"id\": \"a036f63f-7797-40fa-8639-503bfe4d4449\",\n                \"versionId\": \"03fb3d51-7ce8-4fbe-8b67-fe192d6db48e\",\n                \"type\": \"system\",\n                \"state\": \"released\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/it/views/detail/elements/03fb3d51-7ce8-4fbe-8b67-fe192d6db48e\",\n                \"stereotype\": \"applicationSystem\"\n            },\n            {\n                \"facetName\": \"it\",\n                \"id\": \"1f66af8a-6291-4d58-91c4-5c7c61b57995\",\n                \"versionId\": \"ea285079-365b-4e59-88f4-e85b6c1518c4\",\n                \"type\": \"system\",\n                \"state\": \"released\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/it/views/detail/elements/ea285079-365b-4e59-88f4-e85b6c1518c4\",\n                \"stereotype\": \"applicationSystem\"\n            }\n        ],\n        \"systems\": [\n            {\n                \"facetName\": \"it\",\n                \"id\": \"e1cc921b-c8e4-49c9-b9e8-027542eb1716\",\n                \"versionId\": \"7c9b6b04-2a73-4557-97b6-d9b1e490bd5a\",\n                \"type\": \"system\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/it/views/detail/elements/7c9b6b04-2a73-4557-97b6-d9b1e490bd5a\",\n                \"stereotype\": \"applicationSystem\"\n            }\n        ],\n        \"tagFilters\": [\n            {\n                \"facetName\": \"tags\",\n                \"id\": \"b5606290-178e-43ae-837a-f2fd149e4ea9\",\n                \"creationId\": \"b5606290-178e-43ae-837a-f2fd149e4ea9\",\n                \"type\": \"tag\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/tags/views/detail/elements/b5606290-178e-43ae-837a-f2fd149e4ea9\"\n            }\n        ],\n        \"trainings\": [\n            {\n                \"facetName\": \"learning\",\n                \"id\": \"83d40a36-bcd8-4702-b4ea-8c90ae792632\",\n                \"versionId\": \"aa346082-cfc1-4695-accc-a1673947987b\",\n                \"type\": \"training\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/learning/views/detail/elements/aa346082-cfc1-4695-accc-a1673947987b\",\n                \"stereotype\": \"elearning\"\n            }\n        ]\n    }\n}
\n
\n

Get the author and requirements related contexts of an element

\n

Request

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

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 2,\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        \"requirements\": [\n            {\n                \"facetName\": \"requirements\",\n                \"id\": \"19b1188a-6cf8-465b-acc1-1e9134a20b77\",\n                \"versionId\": \"414e448d-6e0e-4db2-9c7f-7c3e3fd37b0b\",\n                \"type\": \"requirement\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/requirements/views/detail/elements/414e448d-6e0e-4db2-9c7f-7c3e3fd37b0b\"\n            },\n            {\n                \"facetName\": \"requirements\",\n                \"id\": \"199c6546-fd51-40b6-a76b-1bbca4cd2bed\",\n                \"versionId\": \"1d5545cd-7d23-4d96-b89b-e44bf176623e\",\n                \"type\": \"requirement\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/requirements/views/detail/elements/1d5545cd-7d23-4d96-b89b-e44bf176623e\"\n            }\n        ]\n    }\n}
\n
\n

Get and expand the author and requirements related contexts of an element

\n

Request

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

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 2,\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        \"requirements\": [\n            {\n                \"facetName\": \"requirements\",\n                \"id\": \"19b1188a-6cf8-465b-acc1-1e9134a20b77\",\n                \"versionId\": \"414e448d-6e0e-4db2-9c7f-7c3e3fd37b0b\",\n                \"type\": \"requirement\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/requirements/views/detail/elements/414e448d-6e0e-4db2-9c7f-7c3e3fd37b0b\",\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                        }\n                    ]\n                }\n            },\n            {\n                \"facetName\": \"requirements\",\n                \"id\": \"199c6546-fd51-40b6-a76b-1bbca4cd2bed\",\n                \"versionId\": \"1d5545cd-7d23-4d96-b89b-e44bf176623e\",\n                \"type\": \"requirement\",\n                \"state\": \"inEffect\",\n                \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/requirements/views/detail/elements/1d5545cd-7d23-4d96-b89b-e44bf176623e\",\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                        }\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 list","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 list of related contexts of an element","depth":3},{"value":"Request","depth":4},{"value":"Response (200 OK)","depth":4},{"value":"Get the author and requirements related contexts of an element","depth":3},{"value":"Request","depth":4},{"value":"Response (200 OK)","depth":4},{"value":"Get and expand the author and requirements 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":"b8fd8ec7-431c-5843-b991-da5a7e6511f9__redocly content/cpm/developer/rest-api/reference/related-list/","seo":{"title":"Related list","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/rest-api/reference/related-list.md","pageBaseUrl":"/cpm/developer/rest-api/reference/related-list","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Related list","id":"related-list"},{"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 list of related contexts of an element","id":"get-the-list-of-related-contexts-of-an-element"},{"depth":4,"value":"Request","id":"request"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok"},{"depth":3,"value":"Get the author and requirements related contexts of an element","id":"get-the-author-and-requirements-related-contexts-of-an-element"},{"depth":4,"value":"Request","id":"request-1"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok-1"},{"depth":3,"value":"Get and expand the author and requirements related contexts of an element","id":"get-and-expand-the-author-and-requirements-related-contexts-of-an-element"},{"depth":4,"value":"Request","id":"request-2"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok-2"},{"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-list/","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"]}