Get Domain Isolation Precheck Status

Get the status of the Domain Isolation Precheck

Request

URI

GET

https://{api_host}/v1/domains/{domainId}/isolation-prechecks/{precheckId}

COPY

Path Parameters

string

domainId

Required

Domain ID

string

precheckId

Required

Precheck ID

Responses

200

Returns IsolationPrecheckResult of type(s) application/json

{
    "precheckFailures": [
        "string"
    ],
    "precheckWarnings": [
        "string"
    ],
    "implications": [
        "string"
    ],
    "executionStatus": "One among: IN_PROGRESS, FAILED, COMPLETED, UNKNOWN, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS"
}

array of string

precheckFailures

Optional

Conditions that will have to be remediated inorder to proceed with isolation operation

array of string

precheckWarnings

Optional

Conditions that may have to cause side effects if not remediated during execution of isolation operation

array of string

implications

Optional

Implications of breaking ELM

string

executionStatus

Required

Execution status of the prechecks

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.