Jump to

• Request
• Response

Get item bulk transcript operations status.

get

/content/management/api/v1.1/items/{id}/metadata/transcripts/.bulk/.status/{statusId}

The response contains fields - progress, completed, body and additionally links if requested.
Progress will represent the job status - succeeded, failed, processing, pending, aborted, paused and blocked.
Completed will be true when the job is succeeded, failed or aborted. If the request has succeeded or failed, the body would contain the result or errors respectively of the job additionally with links if requested.

Request

Path Parameters

• id: string
  id of the item.
• statusId: string
  Status id of the bulk transcript operation

Query Parameters

• links(optional): string
  This is an optional parameter. This parameter accepts a comma-separated list of links to be returned in the response. Possible values are: self, canonical

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : BulkUpdatesStatusBean

Type: object

BulkUpdatesStatusBean

Show Source

• body(optional): object body
  Read Only: true

  results of the job
• completed(optional): boolean
  Read Only: true

  completion status of the job
• links(optional): array links
  Read Only: true

  links to the bulk operation status resource
• progress(optional): string
  Read Only: true

  Allowed Values: [ "succeeded", "failed", "processing", "pending", "aborted", "paused", "blocked" ]

  status of the job

{
    "type":"object",
    "properties":{
        "progress":{
            "type":"string",
            "description":"status of the job",
            "readOnly":true,
            "enum":[
                "succeeded",
                "failed",
                "processing",
                "pending",
                "aborted",
                "paused",
                "blocked"
            ]
        },
        "completed":{
            "type":"boolean",
            "description":"completion status of the job",
            "readOnly":true
        },
        "body":{
            "type":"object",
            "description":"results of the job",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "description":"links to the bulk operation status resource",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"BulkUpdatesStatusBean"
}

Nested Schema : body

Type: object

Read Only: true

results of the job

Nested Schema : links

Type: array

Read Only: true

links to the bulk operation status resource

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"links to the bulk operation status resource",
    "readOnly":true,
    "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."
}

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top