Jump to

• Request
• Response

Copy a category

post

/content/management/api/v1.1/taxonomies/{id}/categories/{categoryId}/copy

and all descendants under a target category.

Request

Supported Media Types

• application/json

Path Parameters

• categoryId: string
  Unique identifier (id) for a category.
• id: string
  id of the taxonomy.

Query Parameters

• links(optional): string
  This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby

Header Parameters

• X-Requested-With: string
  A custom header to mitigate CSRF attacks.

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Category copy request payload. The status and version will be used to determine the source taxonomy. Currently, the status and version are not used because copy is supported only on draft taxonomies.The targetParentId is the parent category for the newly created copy. The targetPosition will be the position of the copy category among its new siblings.

The entire subtree of this category will also be copied. Field apiName will be automatically generated for all copies.

This is an asynchronous operation. Asynchronous request is responded with 202 status with a status link in the location header.

Root Schema : CategoryOperationRequest

Type: object

Category Operation Request

Show Source

• status(optional): string
  Status of the Taxonomy (draft/promoted). This is ignored for a category copy request since only draft taxonomies can be edited.
• targetParentId(optional): string
  The parentId of the copy of the category. This is a required property.
• targetPosition(optional): integer(int32)
  Minimum Value: 0

  The position of the copy of the category among its new siblings. If not provided, the category will be copied in the last position among its new siblings.
• version(optional): integer(int32)
  Version of a Taxonomy. The version field is currently ignored.

{
    "type":"object",
    "properties":{
        "version":{
            "type":"integer",
            "format":"int32",
            "description":"Version of a Taxonomy. The version field is currently ignored."
        },
        "status":{
            "type":"string",
            "description":"Status of the Taxonomy (draft/promoted). This is ignored for a category copy request since only draft taxonomies can be edited."
        },
        "targetParentId":{
            "type":"string",
            "description":"The parentId of the copy of the category. This is a required property."
        },
        "targetPosition":{
            "type":"integer",
            "format":"int32",
            "description":"The position of the copy of the category among its new siblings. If not provided, the category will be copied in the last position among its new siblings.",
            "minimum":0
        }
    },
    "description":"Category Operation Request"
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

The requested resource was not found.

409 Response

The requested resource operation is temporarily unavailable

500 Response

Internal server error.

Back to Top