Jump to

• Request
• Response
• Examples

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"status id of the original request. It is a required property in the get response."
        },
        "startTime":{
            "description":"Time when the original request started",
            "$ref":"#/definitions/date"
        },
        "endTime":{
            "description":"Time when the original request ended",
            "$ref":"#/definitions/date"
        },
        "progress":{
            "type":"string",
            "description":"The current progress of the original request. It is a required property in the get response.",
            "enum":[
                "succeeded",
                "failed",
                "processing",
                "pending",
                "aborted",
                "paused",
                "blocked"
            ]
        },
        "completed":{
            "type":"boolean",
            "description":"Whether the original request is completed or not"
        },
        "message":{
            "type":"string",
            "description":"Human readable message about the current processing status"
        },
        "completedPercentage":{
            "type":"integer",
            "format":"int32",
            "description":"A number between 0 and 100, capturing how much of the process has been completed."
        },
        "requestStatus":{
            "type":"integer",
            "format":"int32",
            "description":"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":{
            "description":"The response when the original async request finishes",
            "$ref":"#/definitions/ResultObject"
        },
        "error":{
            "description":"contains error detail of the original request. This is only available when the original request is processed and failed",
            "$ref":"#/definitions/Error"
        },
        "links":{
            "type":"array",
            "description":"links of the status resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Status"
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"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.

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string",
            "description":"Summary error message. It is a required property in the get response."
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page. It is a required property in the get response."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application specific error code."
        },
        "o:errorDetails":{
            "description":"Drill down to the details. Multiple errors can be organized in a hierarchical structure.",
            "$ref":"#/definitions/Error"
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON patch to indicate where the error occurs."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        }
    },
    "description":"Error"
}

Nested Schema : links

Type: array

links of the status resource

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"links of the status resource",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

{
    "type":"object",
    "properties":{
        "status":{
            "description":"HTTP status line of the response to the original async request",
            "$ref":"#/definitions/ResultHTTPStatus"
        },
        "headers":{
            "type":"array",
            "description":"List of the HTTP headers of the response to the original async request",
            "items":{
                "$ref":"#/definitions/ResultHTTPHeader"
            }
        },
        "body":{
            "type":"object",
            "description":"HTTP body of the response to the original async request"
        }
    },
    "description":"Result"
}

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."
}

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

{
    "type":"array",
    "description":"List of the HTTP headers of the response to the original async request",
    "items":{
        "$ref":"#/definitions/ResultHTTPHeader"
    }
}

Nested Schema : ResultHTTPStatus

Type: object

ResultHTTPStatus

Show Source

• code(optional): integer(int32)
  HTTP response status code
• reason(optional): string
  HTTP response reason phrase

{
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP response status code"
        },
        "reason":{
            "type":"string",
            "description":"HTTP response reason phrase"
        }
    },
    "description":"ResultHTTPStatus"
}

Nested Schema : ResultHTTPHeader

Type: object

ResultHTTPHeader

Show Source

• name(optional): string
  HTTP response header name
• value(optional): string
  HTTP response header value

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"HTTP response header name"
        },
        "value":{
            "type":"string",
            "description":"HTTP response header value"
        }
    },
    "description":"ResultHTTPHeader"
}

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 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"
    }
  ]
}

Back to Top