Get Product Version Catalog Upload Task

Get Product Version Catalog Upload Task

Monitor the progress of a product version catalog upload operation given it's upload task ID.

Request
URI
GET
https://{api_host}/v1/product-version-catalogs/upload-tasks/{taskId}
COPY
Path Parameters
string
taskId
Required

Product Version Catalog Upload ID


Responses
200

Ok

Returns ProductVersionCatalogUploadTask of type(s) application/json
{
    "taskId": "string",
    "description": "string",
    "status": "One among: IN_PROGRESS, SUCCEEDED, FAILED",
    "errorResponse": {
        "errorCode": "string",
        "errorType": "string",
        "arguments": [
            "string"
        ],
        "context": {
            "context": "string"
        },
        "message": "string",
        "remediationMessage": "string",
        "causes": [
            {
                "type": "string",
                "message": "string"
            }
        ],
        "nestedErrors": [
            "Error Object"
        ],
        "referenceToken": "string",
        "label": "string",
        "remediationUrl": "string"
    }
}
string
taskId
Required

ID of the product version catalog upload task

string
description
Required

Description of the product version catalog upload operation

string
status
Required

State of the product version catalog upload after it has completed its execution

object
errorResponse
Optional

Error response containing a minor error code, a localized error message, a localized remediation message and optionally a reference token to correlate the error with the logs


404

Not Found

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/product-version-catalogs/upload-tasks/{taskId}