Read draft creation status

get

/content/management/api/v1.1/taxonomies/{id}/createDraft/{jobTokenId}

Read the status of the job that is creating a new draft from an existing taxonomy.

Request

Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : Status
Type: object
Status
Show Source
Nested Schema : date
Type: object
date
Show Source
Nested Schema : Error
Type: object
Error
Show Source
Nested Schema : ResultObject
Type: object
Result
Show Source
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
Nested Schema : ResultHTTPStatus
Type: object
ResultHTTPStatus
Show Source
Nested Schema : ResultHTTPHeader
Type: object
ResultHTTPHeader
Show Source

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.
Back to Top

Examples

The following example shows how to return the state of a draft creation job by submitting a GET request using cURL.

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/taxonomies/{id}/createDraft/{jobTokenID}'

Example 1:

This returns the job information of the create draft job referenced by the job ID.

/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/createDraft/OP3A2818E5862D4C95B177976016EB815F

Response Body

{
  "id": "OP737526A67C23434C8C0E46F76D6A2356",
  "startTime": {
    "value": "2019-02-06T16:36:05.460Z",
    "timezone": "UTC"
  },
  "endTime": {
    "value": "2019-02-06T16:36:06.110Z",
    "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": "draft",
      "isPublishable": true,
      "isForSiteManagement": false,
      "createdBy": "cecsusername",
      "createdDate": {
        "value": "2019-02-06T16:36:05.659Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecsusername",
      "updatedDate": {
        "value": "2019-02-06T16:36:05.659Z",
        "timezone": "UTC"
      }
    }
  },
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/createDraft/OP737526A67C23434C8C0E46F76D6A2356",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/createDraft/OP737526A67C23434C8C0E46F76D6A2356",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/createDraft/OP737526A67C23434C8C0E46F76D6A2356",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
  ]
}   
Back to Top