Appearance
GET
/web-pages/draft/drafts/{draftId}/categories/{categoryId}Required scope:
viskan:draft:readRetrieves a category by ID.
Parameters
Path parameters
draftId string Format:
uuidIdentifier of the draft. A draft is a workspace that holds unpublished changes to web store content.
categoryId string Format:
uuidIdentifier of the category. Categories form a hierarchical tree structure that organizes pages.
Response
Category successfully retrieved.
JSON
{
"categoryId": "fb840e50-8a8b-477c-a3c8-fffe2bf97e1c",
"categoryName": "Start Page",
"hidden": false,
"indexed": true,
"protectionLevel": "NONE",
"protectionFallbackCategoryId": "0ee32a6e-0c4d-4f7b-bd89-f21ddad81135",
"parentCategoryId": "0ee32a6e-0c4d-4f7b-bd89-f21ddad81135",
"siblingCategoryId": "04e0069f-8f37-43ce-952e-9c248feacb11",
"treePlacement": [
{
"categoryTreeId": "6b2a2871-f20d-4fa0-895e-e3c41976db7a",
"parentCategoryTreeId": "fb840e50-8a8b-477c-a3c8-fffe2bf97e1c",
"siblingCategoryTreeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"status": "MODIFIED"
}
| Error code | Description |
|---|---|
web-pages.retrieve-category.category-not-found | Could not find the category by ID. |
web-pages.retrieve-category.draft-not-found | Draft not found. |