Handle Create 1

Create an onboarding plan in the current organization

Request

URI

POST

https://vra-interop-222-139.lvn.broadcom.net/relocation/onboarding/plan

COPY

Request Body

OnboardingPlanState of type(s) application/json

Required

Show optional properties

{
    "name": "string",
    "projectId": "string"
}

{
    "status": "string",
    "lastRunTimeMicros": 0,
    "nextRefreshTimeMicros": 0,
    "refreshIntervalMicros": 0,
    "description": "string",
    "name": "string",
    "endpointName": "string",
    "projectName": "string",
    "projectId": "string",
    "endpointId": "string",
    "endpointIds": [
        "string"
    ],
    "deploymentTagName": "string",
    "deploymentTagType": "string",
    "createdBy": "string",
    "enableExtensibilityEvents": false,
    "organizationId": "string",
    "customProperties": {
        "customProperties": "string"
    },
    "usePlacements": false
}

string

status

Optional

status

Possible values are : OK, PARTIAL, ERROR, EXECUTING, UPDATING,

integer As int64 As int64

lastRunTimeMicros

Optional

lastRunTimeMicros

integer As int64 As int64

nextRefreshTimeMicros

Optional

nextRefreshTimeMicros

integer As int64 As int64

refreshIntervalMicros

Optional

refreshIntervalMicros

string

description

Optional

Plan description

string

name

Required

Plan name

string

endpointName

Optional

endpointName

string

projectName

Optional

projectName

string

projectId

Required

Project identifier the plan will onboard machines to.

string

endpointId

Optional

endpointId

array of string

endpointIds

Optional

Cloud account identifiers to lookup for discovered machines.

string

deploymentTagName

Optional

deploymentTagName

string

deploymentTagType

Optional

deploymentTagType

Possible values are : TAG, CUSTOM_PROPERTY,

string

createdBy

Optional

createdBy

boolean

enableExtensibilityEvents

Optional

enableExtensibilityEvents

string

organizationId

Optional

organizationId

object

customProperties

Optional

customProperties

boolean

usePlacements

Optional

usePlacements

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Success

Returns OnboardingPlanResponse of type(s) application/json

"OnboardingPlanResponse Object"

string

status

Optional

status

Possible values are : OK, PARTIAL, ERROR, EXECUTING, UPDATING,

integer As int64 As int64

lastRunTimeMicros

Optional

lastRunTimeMicros

integer As int64 As int64

nextRefreshTimeMicros

Optional

nextRefreshTimeMicros

integer As int64 As int64

refreshIntervalMicros

Optional

refreshIntervalMicros

string

description

Optional

Plan description

string

name

Required

Plan name

string

endpointName

Optional

endpointName

string

projectName

Optional

projectName

string

projectId

Required

Project identifier the plan will onboard machines to.

string

endpointId

Optional

endpointId

array of string

endpointIds

Optional

Cloud account identifiers to lookup for discovered machines.

string

deploymentTagName

Optional

deploymentTagName

string

deploymentTagType

Optional

deploymentTagType

Possible values are : TAG, CUSTOM_PROPERTY,

string

createdBy

Optional

createdBy

boolean

enableExtensibilityEvents

Optional

enableExtensibilityEvents

string

organizationId

Optional

organizationId

object

customProperties

Optional

customProperties

boolean

usePlacements

Optional

usePlacements

string

tenantLink

Optional

Link to the plan's tenant.

string

documentSelfLink

Optional

Link to this plan.

401

Unauthorized

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","projectId:"string"}' https://{api_host}/relocation/onboarding/plan

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Onboarding Plans Operations

GET

Handle Get Plan

POST