Retrieve a taxonomy

Request

Retrieves a taxonomy with a specific ID for example color.

Security

OAuth2.0

Path

branchIdstringrequired

The ID of the branch, for example prod.

taxonomyIdstringrequired

The ID of the taxonomy, for example color.

Query

versioninteger, (int32)

The version of the taxonomy.

curl -i -X GET \
  'https://edge-platform.sitecorecloud.io/cs/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}?version=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json

idstring or nullrequired

namestring, non-emptyrequired

systemobject(PublishSystemResource)required

labelstring or null

versioninteger, (int32)

versionTagsArray of strings or null

termsArray of objects or null(TaxonomyTermResponse)

Response

{
  "id": "string",
  "name": "string",
  "label": "string",
  "version": 0,
  "versionTags": [
    "string"
  ],
  "terms": [
    { … }
  ],
  "system": {
    "status": "Draft",
    "availabilityDate": "2019-08-24T14:15:22Z",
    "unavailabilityDate": "2019-08-24T14:15:22Z",
    "publishedAt": "2019-08-24T14:15:22Z",
    "publishedBy": "string",
    "archivedDate": "2019-08-24T14:15:22Z",
    "archivedBy": "string",
    "environment": "string",
    "type": "string",
    "hash": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
}