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://{api_host}/v1/releases
COPY
Query Parameters
string
domainId
Optional

Domain ID to get current release of the domain

domainId example 
9ab78840-ee25-11e8-a8fc-d71c338107bd
string
versionEq
Optional

Release version to get its release

versionEq example 
3.9.0
string
vxRailVersionEq
Optional

Release VxRail version to get its release

vxRailVersionEq example 
3.9.0
string
versionGt
Optional

Release version to get its future releases

versionGt example 
4.0.0.0
string
vxRailVersionGt
Optional

Release vxrail version to get its future releases

vxRailVersionGt example 
7.0.0.0
string
applicableForVersion
Optional

Release version to get applicable releases

applicableForVersion example 
4.0.1.0
string
applicableForVxRailVersion
Optional

Release VxRail version to get applicable releases

applicableForVxRailVersion example 
4.0.1.0
boolean
getFutureReleases
Optional

[Deprecated] Get all future releases for a given domain

getFutureReleases example 
true
Responses
200

Ok

Returns PageOfRelease of type(s) application/json 
{
    "elements": [
        {
            "product": "string",
            "version": "string",
            "minCompatibleVcfVersion": "string",
            "description": "string",
            "releaseDate": "string",
            "bom": [
                {
                    "name": "string",
                    "version": "string",
                    "publicName": "string",
                    "releaseURL": "string",
                    "additionalMetadata": "string"
                }
            ],
            "isApplicable": false,
            "notApplicableReason": "string",
            "sku": [
                {
                    "name": "string",
                    "description": "string",
                    "skuSpecificPatchBundles": [
                        {
                            "bundleType": "string",
                            "bundleVersion": "string",
                            "version": "string"
                        }
                    ],
                    "bom": [
                        {
                            "name": "string",
                            "version": "string",
                            "publicName": "string",
                            "releaseURL": "string",
                            "additionalMetadata": "string"
                        }
                    ]
                }
            ],
            "updates": [
                {
                    "id": "string",
                    "productName": "string",
                    "baseProductVersion": "string",
                    "description": "string",
                    "releaseUpdateURL": "string",
                    "releaseDate": "string"
                }
            ],
            "patchBundles": [
                {
                    "bundleId": "string",
                    "bundleType": "string",
                    "bundleElements": [
                        "string"
                    ],
                    "cumulativeFromVcfVersion": "string"
                }
            ],
            "eol": "string",
            "upgradeOrder": "string"
        }
    ],
    "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


404

Release 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.


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.


Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/v1/releases
On This Page
Releases Operations
GET
Get Releases
GET
Get System Release
GET
Get Future Releases