Jump to

• Request
• Response

Publish a taxonomy

post

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

Publish a promoted taxonomy to the selected channels. Any existing asset categorization for the same promoted taxonomy will become available on the selected channels. User needs to be a contributor on selected channels only when promoted and published taxonomy versions are the same. In case taxonomy promoted version is different than published version, user needs to be a contributor on selected channels and all previously published channels. Only one publish or unpublish request at a time can be active on a taxonomy. If publishing is in progress on a promoted taxonomy, any subsequent requests will result in failure until the initial publishing 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 publishing request payload. Currently, only promoted taxonomies can be published 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 : TaxonomyOperationPublishRequest

Type: object

Taxonomy Operation Publish Request

Show Source

• channels(optional): array channels
  List of publish channels. Parameter channels is mandatory for the first taxonomy publishing. If channels is empty for the first time, an error message will be returned. If channels is empty but taxonomy is still published to other channels, a new version will be published to the current channels. If channels is not empty, taxonomy is published to given channels and any previously published channels (in case a new promoted version is available).
• status(optional): string
  Status of the Taxonomy (draft/promoted). This is ignored for a publishing request since only promoted taxonomies can be published.
• 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 a publishing request since only promoted taxonomies can be published."
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "description":"Version of a Taxonomy. The version field is currently ignored."
        },
        "channels":{
            "type":"array",
            "description":"List of publish channels. Parameter channels is mandatory for the first taxonomy publishing. If channels is empty for the first time, an error message will be returned. If channels is empty but taxonomy is still published to other channels, a new version will be published to the current channels. If channels is not empty, taxonomy is published to given channels and any previously published channels (in case a new promoted version is available).",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        }
    },
    "description":"Taxonomy Operation Publish Request"
}

Nested Schema : channels

Type: array

List of publish channels. Parameter channels is mandatory for the first taxonomy publishing. If channels is empty for the first time, an error message will be returned. If channels is empty but taxonomy is still published to other channels, a new version will be published to the current channels. If channels is not empty, taxonomy is published to given channels and any previously published channels (in case a new promoted version is available).

Show Source

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "description":"List of publish channels. Parameter channels is mandatory for the first taxonomy publishing. If channels is empty for the first time, an error message will be returned. If channels is empty but taxonomy is still published to other channels, a new version will be published to the current channels. If channels is not empty, taxonomy is published to given channels and any previously published channels (in case a new promoted version is available).",
    "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