Handle Get 2

Handle Get 2

Get the selected onboarding plan in the current organization

Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/relocation/onboarding/plan/{id}
COPY
Path Parameters
string
id
Required

The id of the plan

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns OnboardingPlanResponse of type(s) application/json 
{
    "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,
    "tenantLink": "string",
    "documentSelfLink": "string"
}
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 -H 'Authorization: <value>' https://{api_host}/relocation/onboarding/plan/{id}
On This Page
Onboarding Plans Operations
GET
Handle Get Plan
POST
Handle Create 1
GET
Handle Get 2
DELETE
Handle Delete 1
PATCH
Handle Patch 1