Get Future Releases

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. If the domain does not have a product configured at that point, that product will not be included in the BOM or patch bundle list in each release.

Request
URI
GET
https://{api_host}/v1/releases/domains/{domainId}/future-releases
COPY
Path Parameters
string
domainId
Required

Domain ID to get all feature target versions

domainId example 
9ab78840-ee25-11e8-a8fc-d71c338107bd
Responses
200

Ok

Returns PageOfDomainFutureRelease of type(s) application/json 
{
    "elements": [
        {
            "reasonNotApplicable": {
                "component": "string",
                "messageKey": "string",
                "arguments": [
                    "string"
                ],
                "message": "string",
                "bundle": "string"
            },
            "reasonsNotApplicable": [
                {
                    "component": "string",
                    "messageKey": "string",
                    "arguments": [
                        "string"
                    ],
                    "message": "string",
                    "bundle": "string"
                }
            ],
            "warnings": [
                {
                    "component": "string",
                    "messageKey": "string",
                    "arguments": [
                        "string"
                    ],
                    "message": "string",
                    "bundle": "string"
                }
            ],
            "alternativeApplicableSddcManagerVersions": [
                {
                    "version": "string"
                }
            ],
            "applicabilityStatus": "One among: APPLICABLE, NOT_APPLICABLE",
            "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

Domain not found with given ID.

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/domains/{domainId}/future-releases
On This Page
Releases Operations
GET
Get Releases
GET
Get System Release
GET
Get Future Releases