Get Compatibility Matrix

Get Compatibility Matrix

Get Compatibility Matrix

Request
URI
GET
https://sfo-vcf01.rainpole.io/v1/compatibility-matrices/{compatibilityMatrixSource}
COPY
Path Parameters
string
compatibilityMatrixSource
Required

compatibilityMatrixSource of compatibility data

Responses
200

Success

Returns CompatibilityMatrix of type(s) application/json 
{
    "compatibilityMatrixContent": "string",
    "compatibilityMatrixMetadata": {
        "errorMessage": "string",
        "isMissing": false,
        "isStale": false,
        "lastModifiedDate": 0,
        "message": "string",
        "warningMessage": "string"
    },
    "compatibilityMatrixSource": "One among: VMWARE_COMPAT, VXRAIL_COMPAT"
}
string
compatibilityMatrixContent
Required

Content of the compatibility matrix

CompatibilityMatrixMetadata
compatibilityMatrixMetadata
Required

Model for metadata of compatibility matrix

string
compatibilityMatrixSource
Required

Source type of the compatibility matrix content


404

Resource Not Found

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).

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


On This Page
Compatibility Matrix Operations
GET
Get Compatibility Matrices
GET
Get Compatibility Matrix
GET
Get Compatibility Matrix Content
GET
Get Compatibility Matrix Metadata
PUT
Update Compatibility Matrix