Get Personalities

Get Personalities

Get the Personalities which are available via depot access.

Request
URI
GET
https://{api_host}/v1/personalities
COPY
Query Parameters
string
baseOSVersion
Optional

Base OS version

baseOSVersion example
7.0.0-0.0.30340198
string
addOnName
Optional

Add-on name

string
addOnVendorName
Optional

Add-on vendor name

string
componentName
Optional

Component name

string
componentVendorName
Optional

Component vendor name

string
personalityName
Optional

Personality name

string
type
Optional

Personality type

integer
size
Optional
Constraints: default: 2147483647

Size of the page to retrieve. Default page size is 2147483647. Optional

integer
page
Optional
Constraints: default: 1

Page number to retrieve. Default page is 1. Optional

string
sort
Optional
Constraints: default: personalityName

Optional sort to apply to result. List can contain values among: personalityName, addOnName, addOnVendorName, baseOSVersion. Multiple values supported (comma-separated) or multiple occurrences for different sort directions (asc/desc). Example: sort=personalityName,desc


Responses
200

OK

Returns PageOfPersonality of type(s) application/json
{
    "elements": [
        {
            "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"
                        }
                    }
                },
                "removedComponents": {
                    "removedComponents": {
                        "version": "1.3.2.8-1OEM.650.0.0.4598673",
                        "details": {
                            "vendor": "intel",
                            "displayName": "string",
                            "displayVersion": "string"
                        }
                    }
                },
                "hardwareSupport": {
                    "packages": {
                        "packages": {
                            "pkg": "string",
                            "version": "string"
                        }
                    }
                },
                "alternativeImages": {
                    "alternativeImages": {
                        "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"
                                }
                            }
                        },
                        "removedComponents": {
                            "removedComponents": {
                                "version": "1.3.2.8-1OEM.650.0.0.4598673",
                                "details": {
                                    "vendor": "intel",
                                    "displayName": "string",
                                    "displayVersion": "string"
                                }
                            }
                        },
                        "hardwareSupport": {
                            "packages": {
                                "packages": {
                                    "pkg": "string",
                                    "version": "string"
                                }
                            }
                        },
                        "selectionCriteria": {
                            "selectionType": "One among: HOST_UUID, HOST_HARDWARE_SPEC",
                            "hostBiosIds": [
                                "string"
                            ],
                            "hostHardware": {
                                "vendor": "string",
                                "models": [
                                    "string"
                                ],
                                "families": [
                                    "string"
                                ],
                                "oemStrings": [
                                    "string"
                                ]
                            }
                        },
                        "displayName": "string"
                    }
                }
            },
            "type": "One among: SINGLE, COMPOSITE"
        }
    ],
    "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


500

Internal Server Error

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.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/personalities