Rename Personality By Id

Rename Personality By Id

Rename personality with the ID passed in the URL

Request
URI
PATCH
https://{api_host}/v1/personalities/{personalityId}
COPY
Path Parameters
string
personalityId
Required

The personality id

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

Show optional properties

{
    "version": "string",
    "personalityId": "string",
    "personalityName": "string",
    "description": "ESXi 7.0 Dell Personality",
    "imageSize": "string",
    "imageChecksum": "string",
    "vsphereExportedZipPath": "string",
    "vsphereExportedIsoPath": "string",
    "vsphereExportedJsonPath": "string",
    "displayName": "ESXi 7.0 Dell Personality",
    "softwareInfo": {
        "baseImage": {
            "version": "7.0.0-0.0.30340198"
        }
    }
}
{
    "version": "string",
    "personalityId": "string",
    "personalityName": "string",
    "description": "ESXi 7.0 Dell Personality",
    "createdBy": "string",
    "imageSize": "string",
    "imageChecksum": "string",
    "vsphereExportedZipPath": "string",
    "vsphereExportedIsoPath": "string",
    "vsphereExportedJsonPath": "string",
    "displayName": "ESXi 7.0 Dell Personality",
    "releaseDate": "string",
    "importTimestamp": "string",
    "tags": [
        "string"
    ],
    "kbArticles": "string",
    "softwareInfo": {
        "baseImage": {
            "version": "7.0.0-0.0.30340198",
            "details": {
                "displayName": "7.0.0-0.0.30340198",
                "displayVersion": "string",
                "releaseDate": "string",
                "releaseTimestamp": "string",
                "quickPatchCompatibleVersions": [
                    {
                        "version": "8.0.3-0.0.23174786",
                        "displayVersion": "8.0 Update 3 - 23174786"
                    }
                ]
            }
        },
        "addOn": {
            "version": "2.0-1",
            "name": "DELL-sample-Addon",
            "vendor": "Dell",
            "displayName": "string",
            "displayVersion": "string"
        },
        "components": {
            "components": {
                "version": "1.3.2.8-1OEM.650.0.0.4598673",
                "details": {
                    "vendor": "intel",
                    "displayName": "string",
                    "displayVersion": "string"
                }
            }
        },
        "hardwareSupport": {
            "packages": {
                "packages": {
                    "pkg": "string",
                    "version": "string"
                }
            }
        }
    }
}
string
version
Required

Personality Version

string
personalityId
Required

Personality id

string As ^[a-zA-Z\d\-]{3,20}$
personalityName
Required

Personality name

string
description
Required

Personality description

string
createdBy
Optional

Personality created by

string
imageSize
Required

Personality image size

string
imageChecksum
Required

Personality image checksum

string
vsphereExportedZipPath
Required

Personality depot path

string
vsphereExportedIsoPath
Required

Personality depot path

string
vsphereExportedJsonPath
Required

Personality depot path

string
displayName
Required

Personality displayName

string
releaseDate
Optional

Personality Release date

string
importTimestamp
Optional

Timestamp of Personality import into SDDC Manager

array of string
tags
Optional

Personality tags

string
kbArticles
Optional

Personality kb articles

SoftwareInfo
softwareInfo
Required

SoftwareSpec contains base os, components, hardware support, addOn metadata to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

Responses
200

Ok

Returns Personality of type(s) application/json 
{
    "version": "string",
    "personalityId": "string",
    "personalityName": "string",
    "description": "ESXi 7.0 Dell Personality",
    "createdBy": "string",
    "imageSize": "string",
    "imageChecksum": "string",
    "vsphereExportedZipPath": "string",
    "vsphereExportedIsoPath": "string",
    "vsphereExportedJsonPath": "string",
    "displayName": "ESXi 7.0 Dell Personality",
    "releaseDate": "string",
    "importTimestamp": "string",
    "tags": [
        "string"
    ],
    "kbArticles": "string",
    "softwareInfo": {
        "baseImage": {
            "version": "7.0.0-0.0.30340198",
            "details": {
                "displayName": "7.0.0-0.0.30340198",
                "displayVersion": "string",
                "releaseDate": "string",
                "releaseTimestamp": "string",
                "quickPatchCompatibleVersions": [
                    {
                        "version": "8.0.3-0.0.23174786",
                        "displayVersion": "8.0 Update 3 - 23174786"
                    }
                ]
            }
        },
        "addOn": {
            "version": "2.0-1",
            "name": "DELL-sample-Addon",
            "vendor": "Dell",
            "displayName": "string",
            "displayVersion": "string"
        },
        "components": {
            "components": {
                "version": "1.3.2.8-1OEM.650.0.0.4598673",
                "details": {
                    "vendor": "intel",
                    "displayName": "string",
                    "displayVersion": "string"
                }
            }
        },
        "hardwareSupport": {
            "packages": {
                "packages": {
                    "pkg": "string",
                    "version": "string"
                }
            }
        }
    }
}
string
version
Required

Personality Version

string
personalityId
Required

Personality id

string As ^[a-zA-Z\d\-]{3,20}$
personalityName
Required

Personality name

string
description
Required

Personality description

string
createdBy
Optional

Personality created by

string
imageSize
Required

Personality image size

string
imageChecksum
Required

Personality image checksum

string
vsphereExportedZipPath
Required

Personality depot path

string
vsphereExportedIsoPath
Required

Personality depot path

string
vsphereExportedJsonPath
Required

Personality depot path

string
displayName
Required

Personality displayName

string
releaseDate
Optional

Personality Release date

string
importTimestamp
Optional

Timestamp of Personality import into SDDC Manager

array of string
tags
Optional

Personality tags

string
kbArticles
Optional

Personality kb articles

SoftwareInfo
softwareInfo
Required

SoftwareSpec contains base os, components, hardware support, addOn metadata to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.


400

Bad Request

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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.


404

Personality Not Found

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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.


On This Page
Personalities Operations
DELETE
Delete Personality
GET
Get Personalities
GET
Get Personality
PATCH
Rename Personality By Id
POST
Upload Personality
PUT
Upload Personality Files