Changed1

[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

Trigger Partial Retry Of Check Run

Description

Trigger partial retry of a completed check run

Request

URL

patch

https://sfo-vcf01.rainpole.io/v1/system/check-sets/{runId}

Copy

Path Parameters

string

runId Required

UUID of the assessment to retry

Request Body

AssessmentPartialRetryInput of type(s) application/json Required

Spec for assessment retry

{
    "options": "{\"discoveryCaching\": \"true\"}"
}

array of string

errorIds Optional

List of error ids to retry

map of string

options Optional

Options map (toggles) to control assessment flow. Available toggles ‘discoveryCaching’ - if set to true the assessment engine will use the Domain data (if present) from previous discovery execution. If any of the passed in the request domains is not present in the cache the Discovery is triggered for ALL domains (even the ones existing in the cache).

Response

Response Body

202 Accepted

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

string

type Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

Errors

Error

400

Bad Request

Error

500

Internal Server Error

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"options":"{\"discoveryCaching\": \"true\"}"}' https://sfo-vcf01.rainpole.io/v1/system/check-sets/{runId}

vcf

What's changed in latest?

INTRODUCED

Check Sets Operations

get

Get Last Assessment Run Info Introduced

get

Get Result Introduced

post

Query Check Sets Introduced

post

Trigger Check Run Introduced

patch

Trigger Partial Retry Of Check Run Introduced

Trigger Partial Retry Of Check Run

Request

URL

Path Parameters

Request Body

Response

Response Body

202 Accepted

Errors

Code Samples

cURL Command

What's changed in latest?

On This Page

Check Sets Operations

Was this page helpful?