Update Version Alias Configuration

Update Version Alias Configuration

Update Version Alias Configuration.

Request
URI
PUT
https://{api_host}/v1/system/settings/version-aliases/{bundleComponentType}/{version}
COPY
Path Parameters
string
bundleComponentType
Required

Bundle Component Type

string
version
Required

Version


Request Body
AliasSpec of type(s) application/json
Required

Show optional properties

{
    "aliases": [
        {}
    ]
}
{
    "aliases": [
        "string"
    ],
    "forceUpdate": false
}
array of string
aliases
Required

Aliases for bundle component type and version.

boolean
forceUpdate
Optional

Flag for force update version alias configuration.

Responses
200

Ok

Returns PageOfVersionAliasesForBundleComponentType of type(s) application/json
"PageOfVersionAliasesForBundleComponentType Object"
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.


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 -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"aliases":["string"]}' https://{api_host}/v1/system/settings/version-aliases/{bundleComponentType}/{version}