Jump to

• Request
• Response

Get the status of the specified bulk download job.

get

/content/management/api/v1.1/items/_download/{jobId}

Read Bulk Download Job Status.

Request

Path Parameters

• jobId: string
  Bulk download job id.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : BulkDownloadJobStatus

Type: object

BulkDownloadJobStatus

Show Source

• body(optional): object JobStatusBody
• 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.
• details(optional): object JobFileDetailsBean
• links(optional): array links
• 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.

{
    "type":"object",
    "properties":{
        "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"
        },
        "completedPercentage":{
            "type":"integer",
            "format":"int32",
            "description":"A number between 0 and 100, capturing how much of the process has been completed."
        },
        "body":{
            "$ref":"#/definitions/JobStatusBody"
        },
        "details":{
            "$ref":"#/definitions/JobFileDetailsBean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"BulkDownloadJobStatus"
}

Nested Schema : JobStatusBody

Type: object

Show Source

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SkippedItem"
            }
        }
    }
}

Nested Schema : JobFileDetailsBean

Type: object

Show Source

• filename(optional): string
  The suggested filename of the zip file when it is ready for download.
• filesize(optional): integer(int64)
  The file size in bytes of the zip file when it is ready for download.

{
    "type":"object",
    "properties":{
        "filename":{
            "type":"string",
            "description":"The suggested filename of the zip file when it is ready for download."
        },
        "filesize":{
            "type":"integer",
            "format":"int64",
            "description":"The file size in bytes of the zip file when it is ready for download."
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object SkippedItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SkippedItem"
    }
}

Nested Schema : SkippedItem

Type: object

Show Source

• error(optional): string
• id(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "error":{
            "type":"string"
        }
    }
}

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

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top