Get Future Releases | VMware Cloud Foundation API

Get Future Releases

Returns all known to the system future target versions for a domain. If some of them are not allowed (e.g. stepping stone) includes message why.

Request

URI

GET

https://sfo-vcf01.rainpole.io/v1/releases/domains/{domainId}/future-releases

COPY

Path Parameters

string

domainId

Required

Domain ID to get all feature target versions

Responses

200

Returns PageOfDomainFutureRelease of type(s) application/json

{
    "elements": [
        {
            "applicabilityStatus": "One among: APPLICABLE, NOT_APPLICABLE",
            "bom": [
                {
                    "additionalMetadata": "string",
                    "name": "string",
                    "publicName": "string",
                    "releaseURL": "string",
                    "version": "string"
                }
            ],
            "description": "string",
            "eol": "string",
            "isApplicable": false,
            "minCompatibleVcfVersion": "string",
            "notApplicableReason": "string",
            "patchBundles": [
                {
                    "bundleElements": [
                        "string"
                    ],
                    "bundleId": "string",
                    "bundleType": "string",
                    "cumulativeFromVcfVersion": "string"
                }
            ],
            "product": "string",
            "reasonNotApplicable": {
                "arguments": [
                    "string"
                ],
                "component": "string",
                "message": "string",
                "messageKey": "string"
            },
            "releaseDate": "string",
            "sku": [
                {
                    "bom": [
                        {
                            "additionalMetadata": "string",
                            "name": "string",
                            "publicName": "string",
                            "releaseURL": "string",
                            "version": "string"
                        }
                    ],
                    "description": "string",
                    "name": "string",
                    "skuSpecificPatchBundles": [
                        {
                            "bundleType": "string",
                            "bundleVersion": "string",
                            "version": "string"
                        }
                    ]
                }
            ],
            "updates": [
                {
                    "baseProductVersion": "string",
                    "description": "string",
                    "id": "string",
                    "productName": "string",
                    "releaseDate": "string",
                    "releaseUpdateURL": {
                        "authority": "string",
                        "content": {},
                        "defaultPort": 0,
                        "file": "string",
                        "host": "string",
                        "path": "string",
                        "port": 0,
                        "protocol": "string",
                        "query": "string",
                        "ref": "string",
                        "serializedHashCode": 0,
                        "userInfo": "string"
                    }
                }
            ],
            "version": "string"
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}

array of DomainFutureRelease

elements

Optional

The list of elements included in this page

PageMetadata

pageMetadata

Optional

Represents pageable elements pagination metadata

404

Domain not found with given ID.

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "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"
        }
    ],
    "context": {
        "context": "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).