Query Check Sets

Query Check Sets

Query for check-sets for the given resources

Request
URI
POST
https://{api_host}/v1/system/check-sets/queries
COPY
Request Body
CheckSetQueryInput of type(s) application/json
Required

Show optional properties

{
    "checkSetType": "UPGRADE",
    "domains": [
        {
            "domainId": "string"
        }
    ]
}
{
    "checkSetType": "UPGRADE",
    "domains": [
        {
            "domainId": "string",
            "resources": [
                {
                    "resourceType": "VCENTER",
                    "resourceId": "187f6468-f9e0-45f5-8d34-b28efc1e7a36",
                    "resourceTargetVersion": "3.0.0-123456"
                }
            ]
        }
    ]
}
string
checkSetType
Required

Type of the check sets to query for. e.g. 'UPGRADE'

array of CheckSetQueryDomainResources
domains
Required

List of domain resources to query check-sets of the given type for

Responses
200

Ok

Returns CheckSetQueryResult of type(s) application/json 
{
    "queryId": "string",
    "resources": [
        {
            "resourceName": "string",
            "resourceId": "string",
            "resourceType": "string",
            "resourceVersion": "string",
            "domain": {
                "domainId": "string",
                "domainName": "string",
                "domainType": "string"
            },
            "checkSets": [
                {
                    "checkSetId": "string",
                    "checkSetName": "string",
                    "checkSetType": "string"
                }
            ],
            "extraContext": {
                "extraContext": {}
            }
        }
    ]
}
string
queryId
Required

Id of the query, to be provided in the selection API

array of CheckSetQueryResourceResult
resources
Required

Resources with check-sets result from the query


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.


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
Check Sets Operations
GET
Get Last Assessment Run Info
GET
Get Result
POST
Query Check Sets
POST
Trigger Check Run
PATCH
Trigger Partial Retry Of Check Run