Get Product Version Catalog

Get product version catalog. There should be only one valid product version catalog in the System.

Request

URI

GET

https://{api_host}/v1/product-version-catalog

COPY

Responses

200

Returns ProductVersionCatalog of type(s) application/json

{
    "version": 0,
    "sequenceNumber": 0,
    "creationTime": "string",
    "publishedTime": "string",
    "patches": {
        "patches": [
            {
                "productVersion": "string",
                "artifacts": {
                    "bundles": [
                        {
                            "id": "string",
                            "type": "string",
                            "name": "string"
                        }
                    ]
                }
            }
        ]
    }
}

integer As int32 As int32

version

Optional

Product Version catalog version supported by VCF

integer As int32 As int32

sequenceNumber

Optional

Product Version catalog sequence number which signifies an update in the product version catalog

string

creationTime

Optional

Creation time for the Product Version catalog e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format

string

publishedTime

Optional

Time of publish of the Product Version catalog e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format

object

patches

Optional

Patches used for the product version catalog

404

Product Version catalog Not Found

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

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 ErrorCause

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.

500

InternalServerError

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

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.