Get /relocation/onboarding/plan/ {id}

Get /relocation/onboarding/plan/ {id}

Read the service document

Request
URI
GET
https://{api_host}/relocation/onboarding/plan/{id}
COPY
Path Parameters
string
id
Required

id

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns OnboardingPlanState of type(s) application/json 
{
    "description": "string",
    "endpointId": "string",
    "endpointName": "string",
    "name": "string",
    "projectId": "string",
    "projectName": "string",
    "deploymentTagName": "string",
    "deploymentTagType": "string",
    "tenantLink": "string",
    "lastRunTimeMicros": "number",
    "documentSelfLink": "string"
}
string
description
Optional

description

string
endpointId
Optional

endpointId

string
endpointName
Optional

endpointName

string
name
Optional

name

string
projectId
Optional

projectId

string
projectName
Optional

projectName

string
deploymentTagName
Optional

deploymentTagName

string
deploymentTagType
Optional

deploymentTagType

Possible values are : TAG, CUSTOM_PROPERTY,
string
tenantLink
Optional

Link to a tenant

number
lastRunTimeMicros
Optional

lastRunTimeMicros

string
documentSelfLink
Optional

documentSelfLink


404

Error

Returns ServiceErrorResponse of type(s) application/json 
{
    "details": [
        "string"
    ],
    "message": "string",
    "messageId": "string",
    "stackTrace": [
        "string"
    ],
    "statusCode": 0
}
array of string
details
Optional

details

string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int64 As int64
statusCode
Optional

statusCode


On This Page
/relocation/onboarding/plan Operations
DELETE
Delete /relocation/onboarding/plan/ {id}
GET
Get /relocation/onboarding/plan
GET
Get /relocation/onboarding/plan/ {id}
PATCH
Patch /relocation/onboarding/plan/ {id}
POST
Post /relocation/onboarding/plan