Create a new version of a taxonomy

Request

Creates a copy of a taxonomy with the same ID as the original, but the version number is updated (for example, from 1 to 2). You can work on the versions independently.

Security

OAuth2.0

Path

branchIdstringrequired

The ID of the branch, for example prod.

taxonomyIdstringrequired

The ID of the taxonomy, for example running.

Body

required

Parameter containing the taxonomy request.

namestring or null

labelstring or null

versionTagsArray of strings or null

termsArray of objects or null(TaxonomyTermUpdateRequest)

curl -i -X POST \
  'https://edge-platform.sitecorecloud.io/cs/api/v2/cm/branches/{branchId}/taxonomies/{taxonomyId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "name": "string",
    "label": "string",
    "versionTags": [
      "string"
    ],
    "terms": [
      {
        "id": "string",
        "name": "string",
        "label": "string"
      }
    ]
  }'

Responses

New version created successfully

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"
  }
}