Handle Create 4

Handle Create 4
Execute the given onboarding plan

Execute the given onboarding plan in the current organization

Request
URI
POST
https://vcfa-10-162-161-9.vcfd.broadcom.net/relocation/api/wo/execute-plan
COPY
Request Body
PlanExecutionState of type(s) application/json
Required

Show optional properties

{
    "planLink": "string"
}
{
    "planLink": "string",
    "subStage": "string",
    "executionId": "string",
    "planValidated": false,
    "blueprintsValidated": false,
    "deploymentsValidated": false,
    "machinesValidated": false,
    "nextPageLink": "string",
    "deploymentCount": 0,
    "retryCount": 0,
    "failedDeploymentCount": 0,
    "usePlacements": false,
    "placementComputesRetrieved": false,
    "placementToComputesMap": {
        "placementToComputesMap": [
            "string"
        ]
    }
}
string
planLink
Required

Link to the plan to execute.

string
subStage
Optional

subStage

Possible values are : UPDATE_PLAN_STATUS_EXECUTING, DELETE_OLD_REPORTS, VALIDATE_PLAN, VALIDATE_BLUEPRINTS, VALIDATE_DEPLOYMENTS, VALIDATE_MACHINES, POPULATE_PLACEMENTS_COMPUTES, QUERY_RESOURCE_COUNT, QUERY_FIRST_BATCH, GET_BATCH_AND_EXECUTE, WAIT_FOR_BATCH_COMPLETION, UPDATE_PLAN_STATUS_COMPLETE,
string
executionId
Optional

executionId

boolean
planValidated
Optional

planValidated

boolean
blueprintsValidated
Optional

blueprintsValidated

boolean
deploymentsValidated
Optional

deploymentsValidated

boolean
machinesValidated
Optional

machinesValidated

string
nextPageLink
Optional

nextPageLink

integer As int32 As int32
deploymentCount
Optional

deploymentCount

integer As int32 As int32
retryCount
Optional

retryCount

integer As int32 As int32
failedDeploymentCount
Optional

failedDeploymentCount

boolean
usePlacements
Optional

usePlacements

boolean
placementComputesRetrieved
Optional

placementComputesRetrieved

object
placementToComputesMap
Optional

placementToComputesMap

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns PlanExecutionTaskResponse of type(s) application/json 
{
    "planLink": "string",
    "subStage": "string",
    "executionId": "string",
    "planValidated": false,
    "blueprintsValidated": false,
    "deploymentsValidated": false,
    "machinesValidated": false,
    "nextPageLink": "string",
    "deploymentCount": 0,
    "retryCount": 0,
    "failedDeploymentCount": 0,
    "usePlacements": false,
    "placementComputesRetrieved": false,
    "placementToComputesMap": {
        "placementToComputesMap": [
            "string"
        ]
    },
    "failureMessage": "string",
    "tenantLink": "string",
    "documentSelfLink": "string",
    "taskInfo": {
        "stage": "string",
        "isDirect": false,
        "failure": {
            "message": "string",
            "messageId": "string",
            "stackTrace": [
                "string"
            ],
            "statusCode": 0,
            "errorCode": 0,
            "details": [
                "string"
            ],
            "serverErrorId": "string",
            "documentKind": "string",
            "internalErrorCode": 0
        },
        "durationMicros": 0
    }
}
string
planLink
Required

Link to the plan to execute.

string
subStage
Optional

subStage

Possible values are : UPDATE_PLAN_STATUS_EXECUTING, DELETE_OLD_REPORTS, VALIDATE_PLAN, VALIDATE_BLUEPRINTS, VALIDATE_DEPLOYMENTS, VALIDATE_MACHINES, POPULATE_PLACEMENTS_COMPUTES, QUERY_RESOURCE_COUNT, QUERY_FIRST_BATCH, GET_BATCH_AND_EXECUTE, WAIT_FOR_BATCH_COMPLETION, UPDATE_PLAN_STATUS_COMPLETE,
string
executionId
Optional

executionId

boolean
planValidated
Optional

planValidated

boolean
blueprintsValidated
Optional

blueprintsValidated

boolean
deploymentsValidated
Optional

deploymentsValidated

boolean
machinesValidated
Optional

machinesValidated

string
nextPageLink
Optional

nextPageLink

integer As int32 As int32
deploymentCount
Optional

deploymentCount

integer As int32 As int32
retryCount
Optional

retryCount

integer As int32 As int32
failedDeploymentCount
Optional

failedDeploymentCount

boolean
usePlacements
Optional

usePlacements

boolean
placementComputesRetrieved
Optional

placementComputesRetrieved

object
placementToComputesMap
Optional

placementToComputesMap

string
failureMessage
Optional

failureMessage

string
tenantLink
Optional

Link to a tenant

string
documentSelfLink
Optional

documentSelfLink

object
taskInfo
Optional

taskInfo


401

Unauthorized

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"planLink":"string"}' https://{api_host}/relocation/api/wo/execute-plan
On This Page
Onboarding Plan Execution Operations
GET
Handle Get 8
POST
Handle Create 4
GET
Handle Get 7
DELETE
Handle Delete 4