Read promote status
get
/content/management/api/v1.1/taxonomies/{id}/promote/{jobTokenId}
Read the status of the job that is promoting a draft taxonomy.
Request
Path Parameters
-
id: string
id of the taxonomy.
-
jobTokenId: string
id for the job.
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
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : Status
Type:
object
Status
Show Source
-
completed(optional):
boolean
Whether the original request is completed or not
-
completedPercentage(optional):
integer(int32)
A number between 0 and 100, capturing how much of the process has been completed.
-
endTime(optional):
object date
date
-
error(optional):
object Error
Error
-
id(optional):
string
status id of the original request. It is a required property in the get response.
-
links(optional):
array links
links of the status resource
-
message(optional):
string
Human readable message about the current processing status
-
progress(optional):
string
Allowed Values:
[ "succeeded", "failed", "processing", "pending", "aborted", "paused", "blocked" ]
The current progress of the original request. It is a required property in the get response. -
requestStatus(optional):
integer(int32)
HTTP status code of the original request. This is not the polling request's status. Value is available only after the request is completed
-
result(optional):
object ResultObject
Result
-
startTime(optional):
object date
date
Nested Schema : Error
Type:
object
Error
Show Source
-
detail(optional):
string
Detailed error message.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application specific error code.
-
o:errorDetails(optional):
object Error
Error
-
o:errorPath(optional):
string
XPath or JSON patch to indicate where the error occurs.
-
status(optional):
integer(int32)
HTTP status code.
-
title(optional):
string
Summary error message. It is a required property in the get response.
-
type(optional):
string
Link to HTTP error code page. It is a required property in the get response.
Nested Schema : links
Type:
array
links of the status resource
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : ResultObject
Type:
object
Result
Show Source
-
body(optional):
object body
HTTP body of the response to the original async request
-
headers(optional):
array headers
List of the HTTP headers of the response to the original async request
-
status(optional):
object ResultHTTPStatus
ResultHTTPStatus
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.
Nested Schema : body
Type:
object
HTTP body of the response to the original async request
Nested Schema : headers
Type:
array
List of the HTTP headers of the response to the original async request
Show Source
-
Array of:
object ResultHTTPHeader
ResultHTTPHeader
Nested Schema : ResultHTTPStatus
Type:
object
ResultHTTPStatus
Show Source
-
code(optional):
integer(int32)
HTTP response status code
-
reason(optional):
string
HTTP response reason phrase
Nested Schema : ResultHTTPHeader
Type:
object
ResultHTTPHeader
Show Source
-
name(optional):
string
HTTP response header name
-
value(optional):
string
HTTP response header value
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Job not found. The requested resource not found in the system.
500 Response
Internal server error.
Examples
The following example shows how to retrieve the status of a job that is promoting a draft taxonomy by submission of a GET request using cURL:
curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/taxonomies/{id}/promote/{jobTokenID}'
Example:
This retrieves the status of a promote job based on its ID.
/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/promote/OPC7FC2C6D7A8944689E775CCB24313DE3
Response Body
{ "id": "OPC7FC2C6D7A8944689E775CCB24313DE3", "startTime": { "value": "2019-02-06T01:11:35.304Z", "timezone": "UTC" }, "endTime": { "value": "2019-02-06T01:11:35.591Z", "timezone": "UTC" }, "progress": "succeeded", "completed": true, "message": "Job Completed Successfully", "completedPercentage": 100, "result": { "status": { "code": 200, "reason": "" }, "headers": [], "body": { "id": "D7969D6CA0D144AEA9CCA88BA6D2CF81", "name": "Taxonomy 3", "description": "Another description", "shortName": "T3", "status": "promoted", "version": 7, "isPublishable": false, "isForSiteManagement": false, "createdBy": "cecsusername", "createdDate": { "value": "2019-02-01T17:50:26.936Z", "timezone": "UTC" }, "updatedBy": "cecsusername", "updatedDate": { "value": "2019-02-06T01:11:35.483Z", "timezone": "UTC" } } }, "links": [ { "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/promote/OPC7FC2C6D7A8944689E775CCB24313DE3", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/promote/OPC7FC2C6D7A8944689E775CCB24313DE3", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/promote/OPC7FC2C6D7A8944689E775CCB24313DE3", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" } ] }