Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring categories

Retrieve an existing category item.

Retrieve the category with ID {id}.<br />User roles: admin, manager, editor, viewer

get/authoring/v1/categories/{id}

Path parameters

idstring required

The ID of the category to retrieve.

Response

The category was successfully retrieved.

idstring required

The ID of category.

revstring required

The revision of category.

namestring required

The name of the category.

classificationstring required

Either a Taxonomy or category.

descriptionstring

A written representation of the category.

creatorIdstring

The uuid of the user who created the category.

permanentboolean

Used to identify system categories, if true the category can not be deleted.

hiddenboolean

If true the category is hidden in the Shell, value is not returned if false. Default is false.

firstClassForstring

Array of item classifications to which this taxonomy is enabled. Acceptable values "" and "imagesAndVideos", default "". By default the taxonomy is only shown where generic selection of any category in any taxonomy is allowed.

parentstring

The ID of the parent category. This is only required if the classification is a CATEGORY.

ancestorIdsstring[]

An array of IDs for each of the category's ancestor categories. The ID of this category is not included.

namePathstring[] required

An array of names for each of the category's ancestor categories, in addition to the name of this category.

tagsstring[]

Array of tags. This field is applicable only for taxonomy.

lastModifiedstring date required

When the category was last modified in ISO 8601 format.

createdstring date required

When the category was created in ISO 8601 format.