Get Release Components By Sku

Get Release Components By Sku

Gets a list of components, the SKU they are part of and the available patch versions,per release version. By default it provide release components of all the release equal and above 5.x

Request
URI
GET
https://{api_host}/v1/releases/{sku}/release-components
COPY
Path Parameters
string
sku
Required

SKU filter, to retrieve only components associated with a specific SKU (VCF or VVF)

sku example
VCF
Query Parameters
string
releaseVersion
Optional

VCF Release Version

releaseVersion example
9.0.0.0
string
imageType
Optional

image type for the image you want to retrieve.

imageType example
One among: PATCH, INSTALL
boolean
automatedInstall
Optional

Automated Install. If true, list all automated Install product. if false or empty, filter will not be applied. Applicable only for VCF 9.0.0.0 and above releases releases

automatedInstall example
true
string
lifecycleManagedBy
Optional

Lifecycle managed by

lifecycleManagedBy example
One among: SDDC_MANAGER_VCF, VRSLCM
string of array
releaseType
Optional

List of release types

releaseType example
List can contain values among: MAJOR, MINOR, MAINTENANCE, PATCH
string
matchWithReleaseType
Optional

Match with release type for provided releaseVersion

matchWithReleaseType example
One among: MAJOR, MINOR, MAINTENANCE, PATCH

Responses
200

Ok

Returns PageOfReleaseComponentDetail of type(s) application/json
{
    "elements": [
        {
            "releaseVersion": "string",
            "components": [
                {
                    "name": "string",
                    "sku": "string",
                    "publicName": "string",
                    "automatedInstall": false,
                    "versions": [
                        {
                            "productVersion": "string",
                            "date": "string",
                            "artifacts": {
                                "bundles": [
                                    {
                                        "id": "string",
                                        "type": "string",
                                        "name": "string",
                                        "size": 0
                                    }
                                ]
                            }
                        }
                    ]
                }
            ]
        }
    ],
    "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


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

InternalServerError

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/releases/{sku}/release-components