Get Result

Get Result

Get the result for a given check run

Request
URI
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.

Responses
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": {
                "context": "string"
            },
            "errorCode": "string",
            "errorType": "string",
            "message": "string",
            "nestedErrors": [
                "Error Object"
            ],
            "referenceToken": "string",
            "remediationMessage": "string"
        }
    ],
    "physicalPresentedData": {
        "childEntities": [
            "EntityRest Object"
        ],
        "classifications": [
            {
                "description": "string",
                "source": "string",
                "type": "string",
                "value": "string"
            }
        ],
        "description": "string",
        "id": "string",
        "name": "string",
        "properties": {},
        "sourceAddress": "string",
        "type": "string"
    },
    "presentedArtifactsMap": {},
    "relatedAssessmentId": "string",
    "status": "string",
    "timestamp": "string",
    "validationResult": {
        "arguments": [
            "string"
        ],
        "causes": [
            {
                "message": "string",
                "type": "string"
            }
        ],
        "context": {
            "context": "string"
        },
        "errorCode": "string",
        "errorType": "string",
        "message": "string",
        "nestedErrors": [
            "Error Object"
        ],
        "referenceToken": "string",
        "remediationMessage": "string"
    }
}
string
completionTimestamp
Optional

Assessment task completion timestamp

DiscoveryProgress
discoveryProgress
Optional

Information about the assessment run progress.

array of Error
inputValidationErrors
Optional

Set of the input validation errors

EntityRest
physicalPresentedData
Optional

Entity model representing the physical data output of the assessment workflow.

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

Error response containing a minor error code, a localized error message, a localized remediation message and optionally a reference token to correlate the error with the logs


400

Invalid task for this UUID

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


404

No task for this UUID

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