Get Bundle Download Status

Get Bundle Download Status

Get all download status for all bundles matching the criteria. Returns the download information (status, error, taskId) for all bundles matching the criteria (release version, bundle Id, image type).

Request
URI
GET
https://{api_host}/v1/bundles/download-status
COPY
Query Parameters
string
releaseVersion
Optional

Get download status for bundles that are associated with a specific release.

releaseVersion example
9.0.0.0
string
bundleId
Optional

Get the download status for a specific bundle by bundleId.

bundleId example
e6ba8240-d9b7-11ef-bf62-63832c57ab1a
string
imageType
Optional

The image type of the bundle, either INSTALL or PATCH

imageType example
One among: PATCH, INSTALL

Responses
200

OK

Returns PageOfBundleDownloadStatusInfo of type(s) application/json
{
    "elements": [
        {
            "componentType": "string",
            "version": "string",
            "bundleId": "string",
            "downloadId": "string",
            "downloadStatus": "string",
            "downloadedSize": 0,
            "downloadStartTime": 0,
            "downloadEndTime": 0,
            "downloadScheduledTime": 0,
            "isDownloadCancellable": false,
            "message": "string",
            "isDownloadable": false
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of object
elements
Optional

The list of elements included in this page

object
pageMetadata
Optional

Represents pageable elements pagination metadata


400

Bad Request

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


500

Internal Server Error

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/bundles/download-status