Update state of Facility by id or external ref

1min

PUT
https://{domain}/app/api/v2/facilities/{facilityId}/transition
State Transitions Allowed
from_state->to_state
onboarding:onboarding->active:active
active:active->inactive:inactive active:deboard active:pause
active:pause->active:active
active:deboard->active:active inactive:inactive
inactive:inactive->active:active
inactive:terminal->
Header Parameters
X-Solutions-Callback-Secret
string
Body Parameters
body
UpdateStateRequest
Description
Request parameters for updating the State
All Of
StateTransitionRequest  +
toState
string
*
reasonCode
string
data
object
callback
object
Responses
202
Request Accepted
SuccessResponse
error
Error
request
Request
data
Data
default
Default Error Response
DefaultResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{domain}/app/api/v2/facilities/{facilityId}/transition' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "toState": "",
  "callback": {
    "url": ""
  }
}'
curl --location --globoff --request PUT 'https://{domain}/app/api/v2/facilities/{facilityId}/transition' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "toState": "",
  "callback": {
    "url": ""
  }
}'
Responses
202
default
// Request Accepted 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  },
  "data": {
    "id": ""
  }
}
// Request Accepted 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  },
  "data": {
    "id": ""
  }
}
﻿
﻿

from_state	->	to_state
`onboarding:onboarding`	->	`active:active`
`active:active`	->	`inactive:inactive` `active:deboard` `active:pause`
`active:pause`	->	`active:active`
`active:deboard`	->	`active:active` `inactive:inactive`
`inactive:inactive`	->	`active:active`
`inactive:terminal`	->

Updated 01 Dec 2023

Did this page help you?

Get current state of Facility by id or external ref

Get Secure Data