Jump to

• Request
• Response

Unpublish a taxonomy

post

/content/management/api/v1.1/taxonomies/{id}/unpublish

from the selected channels. Taxonomy will no longer be available for the selected channels and any existing categorization information on assets will also be removed. User needs to be a contributor on selected channels. Only one unpublish or publish request at a time can be active on a taxonomy. If unpublishing is in progress on a taxonomy, any subsequent requests will result in failure until the initial unpublishing has completed.

Request

Path Parameters

• 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 ()

Taxonomy unpublishing request payload. Currently, only published taxonomies can be unpublished and thus the status and the version are not used. This is an asynchronous operation. Asynchronous request is responded with 202 status with a status link in the location header.

Root Schema : TaxonomyOperationUnPublishRequest

Type: object

Taxonomy Operation UnPublish Request

Show Source

• channels(optional): array channels
  List of unpublish channels. If channels is not empty, taxonomy is unpublished from given channels. Only channels in the list will be used to unpublish the taxonomy. Parameter channels is mandatory and, in case it is empty, an error message will be returned.
• status(optional): string
  Status of the Taxonomy (draft/promoted). This is ignored for unpublishing request since only published taxonomies can be unpublished.
• version(optional): integer(int32)
  Version of a Taxonomy. The version field is currently ignored.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the Taxonomy (draft/promoted). This is ignored for unpublishing request since only published taxonomies can be unpublished."
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "description":"Version of a Taxonomy. The version field is currently ignored."
        },
        "channels":{
            "type":"array",
            "description":"List of unpublish channels. If channels is not empty, taxonomy is unpublished from given channels. Only channels in the list will be used to unpublish the taxonomy. Parameter channels is mandatory and, in case it is empty, an error message will be returned.",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        }
    },
    "description":"Taxonomy Operation UnPublish Request"
}

Nested Schema : channels

Type: array

List of unpublish channels. If channels is not empty, taxonomy is unpublished from given channels. Only channels in the list will be used to unpublish the taxonomy. Parameter channels is mandatory and, in case it is empty, an error message will be returned.

Show Source

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "description":"List of unpublish channels. If channels is not empty, taxonomy is unpublished from given channels. Only channels in the list will be used to unpublish the taxonomy. Parameter channels is mandatory and, in case it is empty, an error message will be returned.",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

Nested Schema : ChannelId

Type: object

ChannelId

Show Source

• id(optional): string
• isPrimaryChannel(optional): boolean
  Indicates if channel is primary for an asset.
• links(optional): array links
  Links
• name(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isPrimaryChannel":{
            "type":"boolean",
            "description":"Indicates if channel is primary for an asset."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ChannelId"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Taxonomy not found. The requested resource not found.

409 Response

The requested resource operation is temporarily unavailable

500 Response

Internal server error.

Back to Top