Post /relocation/onboarding/rule

Post /relocation/onboarding/rule

Create service instance

Request
URI
POST
https://{api_host}/relocation/onboarding/rule
COPY
Request Body
OnboardingRuleState of type(s) application/json
Optional 
{
    "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

Authentication
This operation uses the following authentication methods.
Responses
200

Success

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


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/relocation/onboarding/rule
On This Page
/relocation/onboarding/rule Operations
GET
Get /relocation/onboarding/rule
POST
Post /relocation/onboarding/rule
GET
Get /relocation/onboarding/rule/ {id}