Get /relocation/onboarding/rule/ {id}

Read the service document

Request

URI

GET

https://{api_host}/relocation/onboarding/rule/{id}

COPY

Path Parameters

string

Required

Authentication

This operation uses the following authentication methods.

apiKey

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 ResourceFieldFilter

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

{
    "details": [
        "string"
    ],
    "message": "string",
    "messageId": "string",
    "stackTrace": [
        "string"
    ],
    "statusCode": 0
}

array of string

details

Optional

details

string

message

Optional

message

string

messageId

Optional

messageId