Promote a taxonomy
post
/content/management/api/v1.1/taxonomies/{id}/promote
Promote a draft taxonomy to be the new promoted taxonomy.
In order to promote a taxonomy, the shortName of the draft taxonomy must be unique. This request will fail in case of any conflicts with the shortName of other taxonomies.
Only one promote request at a time can be active on a draft taxonomy. If a promotion is in progress on a draft taxonomy, any subsequent requests will result in a failure until the initial promotion has completed.
In order to promote a taxonomy, the shortName of the draft taxonomy must be unique. This request will fail in case of any conflicts with the shortName of other taxonomies.
Only one promote request at a time can be active on a draft taxonomy. If a promotion is in progress on a draft taxonomy, any subsequent requests will result in a failure until the initial promotion 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" ]
Taxonomy promote request payload. Currently, only draft taxonomies can be promoted and thus the payload is ignored.
This is an asynchronous operation. Asynchronous request is responded with 202 status with a status link in the location header.
This is an asynchronous operation. Asynchronous request is responded with 202 status with a status link in the location header.
Root Schema : TaxonomyOperationPromoteRequest
Type:
object
Taxonomy Operation Promote Request
Show Source
-
isPublishable(optional):
boolean
Whether taxonomy is publishable. (defaults to false)
-
status(optional):
string
Status of the Taxonomy (draft/promoted). This is ignored for a promotion request since only draft taxonomies can be promoted.
-
version(optional):
integer(int32)
Version of a Taxonomy. The version field is currently ignored.
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.
Examples
The following example shows how to promote draft taxonomies by submitting a POST request on the REST resource using cURL:
curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/taxonomies/{id}/promote'
Example:
This example shows how to start an async job to promote a draft taxonomy.
/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/promote
Request Body
{ "status": "draft" }