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

Views get

\n

api-version: 1.0

\n

Retrieves the list of views.

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

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 10,\n    \"values\": [\n        {\n            \"name\": \"detail\",\n            \"displayName\": \"All information on processes\",\n            \"isHierarchical\": false,\n            \"elements\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements\"\n        },\n        {\n            \"name\": \"detail\",\n            \"displayName\": \"All information on processes\",\n            \"isHierarchical\": false,\n            \"elements\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements\"\n        },\n        {\n            \"name\": \"diagram\",\n            \"displayName\": \"Graphic\",\n            \"isHierarchical\": false,\n            \"elements\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/diagram/elements\"\n        },\n        {\n            \"name\": \"diagram\",\n            \"displayName\": \"Graphic\",\n            \"isHierarchical\": false,\n            \"elements\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/diagram/elements\"\n        },\n        {\n            \"name\": \"diagram\",\n            \"displayName\": \"Graphic\",\n            \"isHierarchical\": false,\n            \"elements\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/diagram/elements\"\n        },\n        {\n            \"name\": \"documentContent\",\n            \"displayName\": \"Document content\",\n            \"isHierarchical\": true,\n            \"elements\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/documentContent/elements\"\n        },\n        {\n            \"name\": \"documentContent\",\n            \"displayName\": \"Document content\",\n            \"isHierarchical\": false,\n            \"elements\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/documentContent/elements\"\n        },\n        {\n            \"name\": \"list\",\n            \"displayName\": \"List\",\n            \"isHierarchical\": false,\n            \"elements\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/list/elements\"\n        },\n        {\n            \"name\": \"reporting\",\n            \"displayName\": \"Report data\",\n            \"isHierarchical\": true,\n            \"elements\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/reporting/elements\"\n        },\n        {\n            \"name\": \"tree\",\n            \"displayName\": \"Architecture\",\n            \"isHierarchical\": true,\n            \"elements\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/tree/elements\"\n        }\n    ]\n}
\n
\n

Definitions

\n

FacetView

\n\n\n\n\n\n\n\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
namestringThe name of the view.
displayNamesDictionary<int, string>The display name of the view on multiple languages.
elementsstringThe URI to retrieve the available elements.
isHierarchicalboolValue indicating wheather this instance is hierarchical
\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":"Views 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":"Request","depth":3},{"value":"Response (200 OK)","depth":3},{"value":"Definitions","depth":2},{"value":"FacetView","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":"acddbd67-5413-5c7c-bd20-90d7353f86c1__redocly content/cpm/developer/rest-api/reference/views/","seo":{"title":"Views get","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/rest-api/reference/views.md","pageBaseUrl":"/cpm/developer/rest-api/reference/views","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Views get","id":"views-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":"Request","id":"request"},{"depth":3,"value":"Response (200 OK)","id":"response-200-ok"},{"depth":2,"value":"Definitions","id":"definitions"},{"depth":3,"value":"FacetView","id":"facetview"},{"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/views/","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"]}