Get /relocation/onboarding/rule/ {id}

Get /relocation/onboarding/rule/ {id}

Read the service document

Request
URI
GET
https://{api_host}/relocation/onboarding/rule/{id}
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns OnboardingRuleState of type(s) application/json 
{
    "disabled": false,
    "filters": [
        {
            "field": "string",
            "values": [
                "string"
            ]
        }
    ],
    "status": "string",
    "name": "string",
    "planLink": "string",
    "tenantLink": "string",
    "documentSelfLink": "string"
}
boolean
disabled
Optional

Rule disabled or not. False by default

array of filters
filters
Optional

Filters associated with this rule

string
status
Optional

Rule status.

Possible values are : OK, UPDATING, CREATING, DELETING, ERROR,
string
name
Optional

Rule name.

string
planLink
Optional

Link to the parent onboarding plan.

string
tenantLink
Optional

Link to a tenant

string
documentSelfLink
Optional

documentSelfLink


404

Error

Returns ServiceErrorResponse of type(s) application/json 
"ServiceErrorResponse Object"
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


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/relocation/onboarding/rule/{id}
On This Page
/relocation/onboarding/rule Operations
GET
Get /relocation/onboarding/rule
POST
Post /relocation/onboarding/rule
GET
Get /relocation/onboarding/rule/ {id}