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

Elements list

\n

api-version: 4.0

\n

Retrieves the list of elements.

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

With optional parameters

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET /{collectionId}/{storageId}/_api/rest/facets/{facetId}/views/{viewId}/elements?$filter={filter}&$select={select}&$expandRelated={expand}&$page={page}&$pageSize={pageSize}&$pageSelectionKey={pageSelectionKey}
\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\n\n\n\n\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
$resourcesquerystring [\"attributes\", \"related\", \"children\", \"content\", \"displayNames\", \"rootPath\"]The resources to include. If not specified all resources will be included.
$selectquerystringA comma separated list of namesof the attributes/related contexts to include.
$expandRelatedquerystringA comma separated list of names of the related contexts to expand.
$pagequeryintegerThe page number.
$pageSizequeryintegerThe page size.
$pageSelectionKeyquerystringThe ID of the element whose page will be fetched.
\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

Get the list of elements 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/elements
\n
\n

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 2,\n    \"elements\": [\n        {\n            \"facetName\": \"processes\",\n            \"id\": \"ab2835f8-da30-4e36-a863-456e1105bb58\",\n            \"creationId\": \"ab2835f8-da30-4e36-a863-456e1105bb58\",\n            \"type\": \"processHouse\",\n            \"attributes\": {\n                \"name\": {\n                    \"1031\": \"Prozesshaus\",\n                    \"1033\": \"Process House\"\n                },\n                \"state1\": {\n                    \"127\": \"show\"\n                }\n            },\n            \"related\": {\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            \"children\": [\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"20e369c5-f0f8-491b-9e7f-f15db6a0fb80\",\n                    \"type\": \"subCategory\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/20e369c5-f0f8-491b-9e7f-f15db6a0fb80\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"24c2a5a1-cdb5-40e7-bb59-4e3d9b1a7ee2\",\n                    \"type\": \"subCategory\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/24c2a5a1-cdb5-40e7-bb59-4e3d9b1a7ee2\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"6823ca8f-1a8b-43e8-ae8c-8b2ef3bd0deb\",\n                    \"type\": \"subCategory\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/6823ca8f-1a8b-43e8-ae8c-8b2ef3bd0deb\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"5cb80f0d-d94f-4d05-8a64-1d98345d481c\",\n                    \"type\": \"subCategory\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/5cb80f0d-d94f-4d05-8a64-1d98345d481c\"\n                }\n            ],\n            \"content\": [\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"20e369c5-f0f8-491b-9e7f-f15db6a0fb80\",\n                    \"type\": \"subCategory\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/20e369c5-f0f8-491b-9e7f-f15db6a0fb80\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"24c2a5a1-cdb5-40e7-bb59-4e3d9b1a7ee2\",\n                    \"type\": \"subCategory\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/24c2a5a1-cdb5-40e7-bb59-4e3d9b1a7ee2\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"6823ca8f-1a8b-43e8-ae8c-8b2ef3bd0deb\",\n                    \"type\": \"subCategory\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/6823ca8f-1a8b-43e8-ae8c-8b2ef3bd0deb\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"5cb80f0d-d94f-4d05-8a64-1d98345d481c\",\n                    \"type\": \"subCategory\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/5cb80f0d-d94f-4d05-8a64-1d98345d481c\"\n                }\n            ]\n        },\n        {\n            \"facetName\": \"processes\",\n            \"id\": \"883669b6-83af-4ce9-b532-b0ba929bef71\",\n            \"type\": \"view\",\n            \"attributes\": {\n                \"name\": {\n                    \"1031\": \"View\",\n                    \"1033\": \"View\"\n                },\n                \"state1\": {\n                    \"127\": \"show\"\n                }\n            },\n            \"related\": {\n                \"author\": [\n                    {\n                        \"facetName\": \"users\",\n                        \"id\": \"ab01a052-80f2-4fbf-8e21-698cb7095b34\",\n                        \"creationId\": \"ab01a052-80f2-4fbf-8e21-698cb7095b34\",\n                        \"type\": \"user\",\n                        \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views/detail/elements/ab01a052-80f2-4fbf-8e21-698cb7095b34\"\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            \"children\": [\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"c6e90187-b9f6-4787-9932-abfea54f5463\",\n                    \"type\": \"view\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/c6e90187-b9f6-4787-9932-abfea54f5463\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"0bcbcd60-1d5b-4c95-a9ef-6e784df55dad\",\n                    \"type\": \"view\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/0bcbcd60-1d5b-4c95-a9ef-6e784df55dad\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"8db17967-8d30-4b75-9eab-434e85bd7df3\",\n                    \"type\": \"view\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/8db17967-8d30-4b75-9eab-434e85bd7df3\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"77181a8e-b6fd-4176-929a-8cafded96cbb\",\n                    \"type\": \"view\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/77181a8e-b6fd-4176-929a-8cafded96cbb\"\n                }\n            ],\n            \"content\": [\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"c6e90187-b9f6-4787-9932-abfea54f5463\",\n                    \"type\": \"view\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/c6e90187-b9f6-4787-9932-abfea54f5463\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"0bcbcd60-1d5b-4c95-a9ef-6e784df55dad\",\n                    \"type\": \"view\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/0bcbcd60-1d5b-4c95-a9ef-6e784df55dad\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"8db17967-8d30-4b75-9eab-434e85bd7df3\",\n                    \"type\": \"view\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/8db17967-8d30-4b75-9eab-434e85bd7df3\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"77181a8e-b6fd-4176-929a-8cafded96cbb\",\n                    \"type\": \"view\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/77181a8e-b6fd-4176-929a-8cafded96cbb\"\n                }\n            ]\n        }\n    ]\n}
\n
\n

Get the list of elements from the tree view of the processes facet with the resources attributes and children

\n

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements?$resources=attributes,children
\n
\n

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 2,\n    \"elements\": [\n        {\n            \"facetName\": \"processes\",\n            \"id\": \"ab2835f8-da30-4e36-a863-456e1105bb58\",\n            \"creationId\": \"ab2835f8-da30-4e36-a863-456e1105bb58\",\n            \"type\": \"processHouse\",\n            \"attributes\": {\n                \"name\": {\n                    \"1031\": \"Prozesshaus\",\n                    \"1033\": \"Process House\"\n                },\n                \"state1\": {\n                    \"127\": \"show\"\n                }\n            },\n            \"children\": [\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"20e369c5-f0f8-491b-9e7f-f15db6a0fb80\",\n                    \"type\": \"subCategory\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/20e369c5-f0f8-491b-9e7f-f15db6a0fb80\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"24c2a5a1-cdb5-40e7-bb59-4e3d9b1a7ee2\",\n                    \"type\": \"subCategory\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/24c2a5a1-cdb5-40e7-bb59-4e3d9b1a7ee2\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"6823ca8f-1a8b-43e8-ae8c-8b2ef3bd0deb\",\n                    \"type\": \"subCategory\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/6823ca8f-1a8b-43e8-ae8c-8b2ef3bd0deb\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"5cb80f0d-d94f-4d05-8a64-1d98345d481c\",\n                    \"type\": \"subCategory\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/5cb80f0d-d94f-4d05-8a64-1d98345d481c\"\n                }\n            ]\n        },\n        {\n            \"facetName\": \"processes\",\n            \"id\": \"883669b6-83af-4ce9-b532-b0ba929bef71\",\n            \"type\": \"view\",\n            \"attributes\": {\n                \"name\": {\n                    \"1031\": \"View\",\n                    \"1033\": \"View\"\n                },\n                \"state1\": {\n                    \"127\": \"show\"\n                }\n            },\n            \"children\": [\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"c6e90187-b9f6-4787-9932-abfea54f5463\",\n                    \"type\": \"view\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/c6e90187-b9f6-4787-9932-abfea54f5463\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"0bcbcd60-1d5b-4c95-a9ef-6e784df55dad\",\n                    \"type\": \"view\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/0bcbcd60-1d5b-4c95-a9ef-6e784df55dad\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"8db17967-8d30-4b75-9eab-434e85bd7df3\",\n                    \"type\": \"view\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/8db17967-8d30-4b75-9eab-434e85bd7df3\"\n                },\n                {\n                    \"facetName\": \"processes\",\n                    \"id\": \"77181a8e-b6fd-4176-929a-8cafded96cbb\",\n                    \"type\": \"view\",\n                    \"expandUri\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements/77181a8e-b6fd-4176-929a-8cafded96cbb\"\n                }\n            ]\n        }\n    ]\n}
\n
\n

Get the list of elements from the detail view of the products facet which are paginated. Result will return first page with 5 elements.

\n

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET https://demo.symbioworld.com/pz/showcase/_api/rest/facets/products/views/detail/elements?$page=1&$pageSize=5
\n
\n

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 5,\n    \"elements\": [\n        {\n            \"facetName\": \"products\",\n            \"id\": \"db73e2d6-445c-44d8-ba35-5015be48ab3f\",\n            \"versionId\": \"81ca054c-5ab8-47d8-aa4a-0c39b551d5d7\",\n            \"type\": \"product\",\n            \"state\": \"inProcess\",\n            \"stereotype\": \"74cc3ec4-b029-4f31-b0e4-8fd0368028ec\",\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\": \"2018-06-29T14:43:30\"\n                },\n                \"createdOn\": {\n                    \"127\": \"2018-06-28T09:52:10\"\n                },\n                \"gotoUrl\": {\n                    \"1031\": \"https://demo.symbioworld.com/pz/showcase/1031/BasePlugin/GoTo/Products/personalizedgraphic/81ca054c-5ab8-47d8-aa4a-0c39b551d5d7\",\n                    \"1033\": \"https://demo.symbioworld.com/pz/showcase/1033/BasePlugin/GoTo/Products/personalizedgraphic/81ca054c-5ab8-47d8-aa4a-0c39b551d5d7\"\n                },\n                \"isReleased\": {\n                    \"127\": false\n                },\n                \"name\": {\n                    \"1031\": \"Sicherheitscheck\",\n                    \"1033\": \"Security check\"\n                },\n                \"state1\": {\n                    \"127\": \"inProcess\"\n                },\n                \"stereotype\": {\n                    \"127\": \"74cc3ec4-b029-4f31-b0e4-8fd0368028ec\"\n                },\n                \"validUntil\": {\n                    \"127\": \"2019-06-28T00: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            }\n        },\n        {\n            \"facetName\": \"products\",\n            \"id\": \"65ad489f-d385-4d4c-b059-0336b8758d44\",\n            \"versionId\": \"9c4282b3-f1bb-4d7d-b909-b3dd5ed04121\",\n            \"type\": \"product\",\n            \"state\": \"inProcess\",\n            \"stereotype\": \"74cc3ec4-b029-4f31-b0e4-8fd0368028ec\",\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\": \"2018-06-29T14:42:36\"\n                },\n                \"createdOn\": {\n                    \"127\": \"2018-06-28T09:54:46\"\n                },\n                \"gotoUrl\": {\n                    \"1031\": \"https://demo.symbioworld.com/pz/showcase/1031/BasePlugin/GoTo/Products/personalizedgraphic/9c4282b3-f1bb-4d7d-b909-b3dd5ed04121\",\n                    \"1033\": \"https://demo.symbioworld.com/pz/showcase/1033/BasePlugin/GoTo/Products/personalizedgraphic/9c4282b3-f1bb-4d7d-b909-b3dd5ed04121\"\n                },\n                \"isReleased\": {\n                    \"127\": false\n                },\n                \"name\": {\n                    \"1031\": \"Großkunden und Unternehmen\",\n                    \"1033\": \"Grokunden and company\"\n                },\n                \"state1\": {\n                    \"127\": \"inProcess\"\n                },\n                \"stereotype\": {\n                    \"127\": \"74cc3ec4-b029-4f31-b0e4-8fd0368028ec\"\n                },\n                \"validUntil\": {\n                    \"127\": \"2019-06-28T00: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            }\n        },\n        {\n            \"facetName\": \"products\",\n            \"id\": \"23f68bea-ce13-4cf7-b718-f5d65962fd86\",\n            \"versionId\": \"d0f7a0a8-a0ec-4f65-9fd2-1f9f0dcaaa8f\",\n            \"type\": \"product\",\n            \"state\": \"inProcess\",\n            \"stereotype\": \"9ec2e51b-e933-4a4c-9eff-870ba624462b\",\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\": \"2018-07-02T13:36:42\"\n                },\n                \"createdOn\": {\n                    \"127\": \"2018-06-28T09:43:44\"\n                },\n                \"gotoUrl\": {\n                    \"1031\": \"https://demo.symbioworld.com/pz/showcase/1031/BasePlugin/GoTo/Products/personalizedgraphic/d0f7a0a8-a0ec-4f65-9fd2-1f9f0dcaaa8f\",\n                    \"1033\": \"https://demo.symbioworld.com/pz/showcase/1033/BasePlugin/GoTo/Products/personalizedgraphic/d0f7a0a8-a0ec-4f65-9fd2-1f9f0dcaaa8f\"\n                },\n                \"isReleased\": {\n                    \"127\": false\n                },\n                \"name\": {\n                    \"1031\": \"Dynamos\",\n                    \"1033\": \"Dynamos\"\n                },\n                \"state1\": {\n                    \"127\": \"inProcess\"\n                },\n                \"stereotype\": {\n                    \"127\": \"9ec2e51b-e933-4a4c-9eff-870ba624462b\"\n                },\n                \"validUntil\": {\n                    \"127\": \"2019-06-28T00: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            }\n        },\n        {\n            \"facetName\": \"products\",\n            \"id\": \"8414869f-145d-4e37-a61a-08f111208188\",\n            \"versionId\": \"aae105f6-fc92-444d-8d3f-07f0adaeb503\",\n            \"type\": \"product\",\n            \"state\": \"inProcess\",\n            \"stereotype\": \"74cc3ec4-b029-4f31-b0e4-8fd0368028ec\",\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\": \"2018-07-02T13:26:38\"\n                },\n                \"createdOn\": {\n                    \"127\": \"2018-06-29T12:21:16\"\n                },\n                \"gotoUrl\": {\n                    \"1031\": \"https://demo.symbioworld.com/pz/showcase/1031/BasePlugin/GoTo/Products/personalizedgraphic/aae105f6-fc92-444d-8d3f-07f0adaeb503\",\n                    \"1033\": \"https://demo.symbioworld.com/pz/showcase/1033/BasePlugin/GoTo/Products/personalizedgraphic/aae105f6-fc92-444d-8d3f-07f0adaeb503\"\n                },\n                \"isReleased\": {\n                    \"127\": false\n                },\n                \"name\": {\n                    \"1031\": \"Ersatzteile\",\n                    \"1033\": \"Spare parts\"\n                },\n                \"state1\": {\n                    \"127\": \"inProcess\"\n                },\n                \"stereotype\": {\n                    \"127\": \"74cc3ec4-b029-4f31-b0e4-8fd0368028ec\"\n                },\n                \"validUntil\": {\n                    \"127\": \"2019-06-29T00: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            }\n        },\n        {\n            \"facetName\": \"products\",\n            \"id\": \"d2f0097b-21ad-461d-8f7f-6a0ee44f6c24\",\n            \"versionId\": \"a343b47d-b890-4ae0-bddd-225cabcc8e27\",\n            \"type\": \"product\",\n            \"state\": \"inProcess\",\n            \"stereotype\": \"9ec2e51b-e933-4a4c-9eff-870ba624462b\",\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\": \"2018-07-02T13:33:55\"\n                },\n                \"createdOn\": {\n                    \"127\": \"2018-06-28T09:46:54\"\n                },\n                \"gotoUrl\": {\n                    \"1031\": \"https://demo.symbioworld.com/pz/showcase/1031/BasePlugin/GoTo/Products/personalizedgraphic/a343b47d-b890-4ae0-bddd-225cabcc8e27\",\n                    \"1033\": \"https://demo.symbioworld.com/pz/showcase/1033/BasePlugin/GoTo/Products/personalizedgraphic/a343b47d-b890-4ae0-bddd-225cabcc8e27\"\n                },\n                \"isReleased\": {\n                    \"127\": false\n                },\n                \"name\": {\n                    \"1031\": \"Hosen\",\n                    \"1033\": \"Pants\"\n                },\n                \"state1\": {\n                    \"127\": \"inProcess\"\n                },\n                \"stereotype\": {\n                    \"127\": \"9ec2e51b-e933-4a4c-9eff-870ba624462b\"\n                },\n                \"validUntil\": {\n                    \"127\": \"2019-06-28T00: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            }\n        }\n    ]\n}
\n
\n

Get the list of storage collections

\n

!!! info\nThis call only works on the _sysadmin collection and _admin storage.

\n

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET https://demo.symbioworld.com/_sysadmin/_admin/_api/rest/facets/collections/views/list/elements
\n
\n

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 1,\n    \"elements\": [\n        {\n            \"id\": \"0c0f489a-bc63-4f75-ac0b-054f33083878\",\n            \"type\": \"collection\",\n            \"attributes\": {\n                \"id\": {\n                    \"127\": \"pz\"\n                },\n                \"name\": {\n                    \"1031\": \"pz\",\n                    \"1033\": \"pz\"\n                }\n            }\n        }\n    ]\n}
\n
\n

Get the list of storages of a specific collection

\n

!!! info\nThis call only works on the _admin storage.

\n

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET https://demo.symbioworld.com/pz/_admin/_api/rest/facets/storages/views/detail/elements
\n
\n

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 1,\n    \"elements\": [\n        {\n            \"id\": \"b028e1b3-88e8-4564-be04-bb9f204c842b\",\n            \"type\": \"storage\",\n            \"attributes\": {\n                \"changedOn\": {\n                    \"127\": \"2018-03-07T10:09:41\"\n                },\n                \"createdOn\": {\n                    \"127\": \"2018-03-07T10:09:06\"\n                },\n                \"id\": {\n                    \"127\": \"showcase\"\n                },\n                \"name\": {\n                    \"1031\": \"showcase\",\n                    \"1033\": \"showcase\"\n                }\n            },\n            \"related\": {\n                \"changedBy\": [\n                    {\n                        \"id\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                        \"type\": \"user\",\n                        \"expandUri\": \"https://demo.symbioweb.com/pz/_admin/Master_api/rest/facets/Users/views/List/elements/a364f30b-a126-4a74-9e1a-1df87f2a6074\"\n                    }\n                ],\n                \"createdBy\": [\n                    {\n                        \"id\": \"a364f30b-a126-4a74-9e1a-1df87f2a6074\",\n                        \"type\": \"user\",\n                        \"expandUri\": \"https://demo.symbioweb.com/pz/_admin/Master_api/rest/facets/Users/views/List/elements/a364f30b-a126-4a74-9e1a-1df87f2a6074\"\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":"Elements 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 elements from the tree view of the processes facet","depth":3},{"value":"Request","depth":4},{"value":"Response (200 OK)","depth":4},{"value":"Get the list of elements from the tree view of the processes facet with the resources attributes and children","depth":3},{"value":"Request","depth":4},{"value":"Response (200 OK)","depth":4},{"value":"Get the list of elements from the detail view of the products facet which are paginated. Result will return first page with 5 elements.","depth":3},{"value":"Request","depth":4},{"value":"Response (200 OK)","depth":4},{"value":"Get the list of storage collections","depth":3},{"value":"Request","depth":4},{"value":"Response (200 OK)","depth":4},{"value":"Get the list of storages of a specific collection","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":"2d44550e-a772-562f-839e-857c93f231a1__redocly content/cpm/developer/rest-api/reference/elements-list/","seo":{"title":"Elements list","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/rest-api/reference/elements-list.md","pageBaseUrl":"/cpm/developer/rest-api/reference/elements-list","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Elements list","id":"elements-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 elements from the tree view of the processes facet","id":"get-the-list-of-elements-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 list of elements from the tree view of the processes facet with the resources attributes and children","id":"get-the-list-of-elements-from-the-tree-view-of-the-processes-facet-with-the-resources-attributes-and-children"},{"depth":4,"value":"Request","id":"request-1"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok-1"},{"depth":3,"value":"Get the list of elements from the detail view of the products facet which are paginated. Result will return first page with 5 elements.","id":"get-the-list-of-elements-from-the-detail-view-of-the-products-facet-which-are-paginated-result-will-return-first-page-with-5-elements"},{"depth":4,"value":"Request","id":"request-2"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok-2"},{"depth":3,"value":"Get the list of storage collections","id":"get-the-list-of-storage-collections"},{"depth":4,"value":"Request","id":"request-3"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok-3"},{"depth":3,"value":"Get the list of storages of a specific collection","id":"get-the-list-of-storages-of-a-specific-collection"},{"depth":4,"value":"Request","id":"request-4"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok-4"},{"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-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"]}