Get Releases

Get Releases

Get all Releases, with option to get current release for a domain, get release by version or get future releases for a versionor get all the applicable target release.

Request
URI
GET
https://sfo-vcf01.rainpole.io//v1/releases
COPY
Query Parameters
string
domainId
Optional

Domain ID to get current release of the domain

string
versionEq
Optional

Release version to get its release

string
vxRailVersionEq
Optional

Release VxRail version to get its release

string
versionGt
Optional

Release version to get its future releases

string
vxRailVersionGt
Optional

Release vxrail version to get its future releases

string
applicableForVersion
Optional

Release version to get applicable releases

string
applicableForVxRailVersion
Optional

Release VxRail version to get applicable releases

boolean
getFutureReleases
Optional

[Deprecated] Get all future releases for a given domain


Responses
200

Ok

Returns PageOfRelease of type(s) application/json
{
    "elements": [
        {
            "bom": [
                {
                    "additionalMetadata": "string",
                    "name": "string",
                    "publicName": "string",
                    "releaseURL": {
                        "authority": "string",
                        "defaultPort": 0,
                        "file": "string",
                        "host": "string",
                        "path": "string",
                        "port": 0,
                        "protocol": "string",
                        "query": "string",
                        "ref": "string",
                        "userInfo": "string"
                    },
                    "version": "string"
                }
            ],
            "description": "string",
            "eol": "string",
            "isApplicable": false,
            "minCompatibleVcfVersion": "string",
            "notApplicableReason": "string",
            "patchBundles": [
                {
                    "bundleElements": [
                        "string"
                    ],
                    "bundleId": "string",
                    "bundleType": "string",
                    "cumulativeFromVcfVersion": "string"
                }
            ],
            "product": "string",
            "releaseDate": "string",
            "sku": [
                {
                    "bom": [
                        {
                            "additionalMetadata": "string",
                            "name": "string",
                            "publicName": "string",
                            "releaseURL": {
                                "authority": "string",
                                "defaultPort": 0,
                                "file": "string",
                                "host": "string",
                                "path": "string",
                                "port": 0,
                                "protocol": "string",
                                "query": "string",
                                "ref": "string",
                                "userInfo": "string"
                            },
                            "version": "string"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "skuSpecificPatchBundles": [
                        {
                            "bundleElements": [
                                "string"
                            ],
                            "bundleId": "string",
                            "bundleType": "string",
                            "cumulativeFromVcfVersion": "string"
                        }
                    ]
                }
            ],
            "updates": [
                {
                    "baseProductVersion": "string",
                    "description": "string",
                    "id": "string",
                    "productName": "string",
                    "releaseDate": "string",
                    "releaseUpdateURL": {
                        "authority": "string",
                        "defaultPort": 0,
                        "file": "string",
                        "host": "string",
                        "path": "string",
                        "port": 0,
                        "protocol": "string",
                        "query": "string",
                        "ref": "string",
                        "userInfo": "string"
                    }
                }
            ],
            "version": "string"
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of Release
elements
Optional

The list of elements included in this page

pageMetadata
Optional

pageMetadata


404

Release not found

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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
remediationMessage
Optional

The localized remediation error message


500

Internal Server Error

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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
remediationMessage
Optional

The localized remediation error message