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

Facets list

\n

api-version: 1.0

\n

Retrieves the list of facets.

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

\n

Request

\n
\n
\n
Copy
\n
Copied
\n
\n 
GET https://demo.symbioworld.com/pz/showcase/_api/rest/facets/
\n
\n

Response (200 OK)

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"count\": 41,\n    \"values\": [\n        {\n            \"name\": \"automation\",\n            \"displayName\": \"Automation\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/automation/views\"\n        },\n        {\n            \"name\": \"bestPracticeTasks\",\n            \"displayName\": \"Best practice tasks\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/bestPracticeTasks/views\"\n        },\n        {\n            \"name\": \"capability\",\n            \"displayName\": \"Capability\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/capability/views\"\n        },\n        {\n            \"name\": \"cultures\",\n            \"displayName\": \"Languages\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/cultures/views\"\n        },\n        {\n            \"name\": \"customerjourneystages\",\n            \"displayName\": \"Customer journey stages\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/customerjourneystages/views\"\n        },\n        {\n            \"name\": \"customerstructure\",\n            \"displayName\": \"Customers\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/customerstructure/views\"\n        },\n        {\n            \"name\": \"docContent\",\n            \"displayName\": \"DocContent\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/docContent/views\"\n        },\n        {\n            \"name\": \"docTemplates\",\n            \"displayName\": \"Document Templates\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/docTemplates/views\"\n        },\n        {\n            \"name\": \"globaltasks\",\n            \"displayName\": \"Task repository\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/globaltasks/views\"\n        },\n        {\n            \"name\": \"groups\",\n            \"displayName\": \"Groups\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/groups/views\"\n        },\n        {\n            \"name\": \"inputsoutputs\",\n            \"displayName\": \"Inputs/Outputs\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/inputsoutputs/views\"\n        },\n        {\n            \"name\": \"it\",\n            \"displayName\": \"Systems\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/it/views\"\n        },\n        {\n            \"name\": \"knowledge\",\n            \"displayName\": \"Documents\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/knowledge/views\"\n        },\n        {\n            \"name\": \"kpi\",\n            \"displayName\": \"Key Performance Indicators\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/kpi/views\"\n        },\n        {\n            \"name\": \"learning\",\n            \"displayName\": \"Learning\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/learning/views\"\n        },\n        {\n            \"name\": \"locations\",\n            \"displayName\": \"Locations\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/locations/views\"\n        },\n        {\n            \"name\": \"measures\",\n            \"displayName\": \"Measures\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/measures/views\"\n        },\n        {\n            \"name\": \"milestones\",\n            \"displayName\": \"Milestones\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/milestones/views\"\n        },\n        {\n            \"name\": \"organization\",\n            \"displayName\": \"Organization\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/organization/views\"\n        },\n        {\n            \"name\": \"overviewpages\",\n            \"displayName\": \"Overview pages\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/overviewpages/views\"\n        },\n        {\n            \"name\": \"permissionsets\",\n            \"displayName\": \"Permission sets\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/permissionsets/views\"\n        },\n        {\n            \"name\": \"personas\",\n            \"displayName\": \"Personas\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/personas/views\"\n        },\n        {\n            \"name\": \"processes\",\n            \"displayName\": \"Processes\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views\"\n        },\n        {\n            \"name\": \"products\",\n            \"displayName\": \"Products\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/products/views\"\n        },\n        {\n            \"name\": \"projects\",\n            \"displayName\": \"Projects\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/projects/views\"\n        },\n        {\n            \"name\": \"reportsources\",\n            \"displayName\": \"Reporting\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/reportsources/views\"\n        },\n        {\n            \"name\": \"requirements\",\n            \"displayName\": \"Requirements\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/requirements/views\"\n        },\n        {\n            \"name\": \"risks\",\n            \"displayName\": \"Risks\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/risks/views\"\n        },\n        {\n            \"name\": \"roles\",\n            \"displayName\": \"Roles\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/roles/views\"\n        },\n        {\n            \"name\": \"saleschannels\",\n            \"displayName\": \"Sales channels\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/saleschannels/views\"\n        },\n        {\n            \"name\": \"search\",\n            \"displayName\": \"Search\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/search/views\"\n        },\n        {\n            \"name\": \"stakeholders\",\n            \"displayName\": \"Stakeholders\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/stakeholders/views\"\n        },\n        {\n            \"name\": \"standards\",\n            \"displayName\": \"Standards\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/standards/views\"\n        },\n        {\n            \"name\": \"stereotypes\",\n            \"displayName\": \"Stereotypes\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/stereotypes/views\"\n        },\n        {\n            \"name\": \"strategy\",\n            \"displayName\": \"Strategy\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/strategy/views\"\n        },\n        {\n            \"name\": \"tags\",\n            \"displayName\": \"Tags\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/tags/views\"\n        },\n        {\n            \"name\": \"touchpoints\",\n            \"displayName\": \"Touch Points\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/touchpoints/views\"\n        },\n        {\n            \"name\": \"transactions\",\n            \"displayName\": \"Application services\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/transactions/views\"\n        },\n        {\n            \"name\": \"usergroups\",\n            \"displayName\": \"User groups\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/usergroups/views\"\n        },\n        {\n            \"name\": \"users\",\n            \"displayName\": \"User\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/users/views\"\n        },\n        {\n            \"name\": \"voiceofcustomers\",\n            \"displayName\": \"Voice of customers\",\n            \"views\": \"https://demo.symbioworld.com/pz/showcase/_api/rest/facets/voiceofcustomers/views\"\n        }\n    ]\n}
\n
\n

Definitions

\n

Facet

\n\n\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.
viewsstringThe URI to retrieve the available views.
\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":"Facets 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 facets","depth":3},{"value":"Request","depth":4},{"value":"Response (200 OK)","depth":4},{"value":"Definitions","depth":2},{"value":"Facet","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":"f5396f44-c75e-5269-b8a4-9ece2506ef4b__redocly content/cpm/developer/rest-api/reference/facets/","seo":{"title":"Facets list","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/rest-api/reference/facets.md","pageBaseUrl":"/cpm/developer/rest-api/reference/facets","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Facets list","id":"facets-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 facets","id":"get-the-list-of-facets"},{"depth":4,"value":"Request","id":"request"},{"depth":4,"value":"Response (200 OK)","id":"response-200-ok"},{"depth":2,"value":"Definitions","id":"definitions"},{"depth":3,"value":"Facet","id":"facet"},{"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/facets/","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"]}