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/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]

vcf-for-vxrail

Get Result

Description

Get the result for a given check run

Request

URL

get

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

Copy

Path Parameters

string

runId Required

UUID of the task

Query Parameters

boolean

obfuscate Optional

Obfuscate. Only for internal use.

boolean

returnAllArtefacts Optional

Returns all artefacts. Only for internal use.

Response

Response Body

200 OK

Returns AssessmentOutput of type(s) application/json

{
	"completionTimestamp": "string",
	"discoveryProgress": {
		"percentageComplete": 0,
		"progressMessages": [
			"string"
		]
	},
	"inputValidationErrors": [
		{
			"arguments": [
				"string"
			],
			"causes": [
				{
					"message": "string",
					"type": "string"
				}
			],
			"context": {
				"key": "string"
			},
			"errorCode": "string",
			"errorType": "string",
			"message": "string",
			"nestedErrors": "Error Object",
			"referenceToken": "string",
			"remediationMessage": "string"
		}
	],
	"physicalPresentedData": {
		"childEntities": "EntityRest Object",
		"classifications": [
			{
				"description": "string",
				"source": "CLASSIFIER",
				"type": "string",
				"value": "string"
			}
		],
		"description": "string",
		"id": "string",
		"name": "string",
		"properties": {},
		"sourceAddress": "string",
		"type": "string"
	},
	"presentedArtifactsMap": {},
	"relatedAssessmentId": "string",
	"status": "IN_PROGRESS",
	"timestamp": "string",
	"validationResult": {
		"arguments": [
			"string"
		],
		"causes": [
			{
				"message": "string",
				"type": "string"
			}
		],
		"context": {
			"key": "string"
		},
		"errorCode": "string",
		"errorType": "string",
		"message": "string",
		"nestedErrors": "Error Object",
		"referenceToken": "string",
		"remediationMessage": "string"
	}
}

string

completionTimestamp Optional

Assessment task completion timestamp

DiscoveryProgress

discoveryProgress Optional

Progress messages

array of Error

inputValidationErrors Optional

Set of the input validation errors

EntityRest

physicalPresentedData Optional

The root entity with its child entities effectively representing the complete assessed environment tree

object

presentedArtifactsMap Optional

Extra assessment artefacts produced by the workflow

string

relatedAssessmentId Optional

Related assessment run id

string

status Optional

Execution status

Possible values are: IN_PROGRESS , COMPLETED_WITH_SUCCESS , COMPLETED_WITH_FAILURE

string

timestamp Optional

Assessment task creation timestamp

Error

validationResult Optional

Result from the assessed validation rules

Errors

Error

400

Invalid task for this UUID

Error

404

No task for this UUID

Error

500

Internal Server Error

Code Samples

cURL Command

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

vcf-for-vxrail

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

Get Result

Request

URL

Path Parameters

Query Parameters

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

What's changed in latest?

On This Page

Check Sets Operations

Was this page helpful?