Update state machine configuration for a participant type

1min
PUT
https://{tenantSubdomain}/core/api/v2/participants/participant-types/{participantTypePluralName}/config/state-machine
This API is for updating the current state-machine configuration (states, sub-states and state transition rules) of a participant type specified by participantTypeName. For each non-terminal sub-state, at least one state transition rule is expected.


Transition rule comprises of:
Event Code
Destination State or Sub-State. If destination state is mentioned then the default sub-state of that state is considered as the destination sub-state.
Reason Code

Important: The state machine cannot be partially updated.
Path Parameters
participantTypePluralName
ParticipantTypePluralName
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Body Parameters
body
StateMachineUpdateRequest
*
Description
Update participant type state machine
All Of
StateMachineConfig  +
states
States
*
Responses
200
OK - The request Succeeded.
SuccessResponse
data
NameResponse
request
Request
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error
ErrorResponse
error
Error
*
request
Request
*
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that tenant.
ErrorResponse
error
Error
*
request
Request
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{tenantSubdomain}/core/api/v2/participants/participant-types/{participantTypePluralName}/config/state-machine' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "states": {
    "onboarding": {},
    "active": {},
    "inactive": {}
  }
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}/core/api/v2/participants/participant-types/{participantTypePluralName}/config/state-machine' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "states": {
    "onboarding": {},
    "active": {},
    "inactive": {}
  }
}'
Responses
200
400
401
404
// OK - The request Succeeded. 
{
  "data": {
    "name": "vehicles"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK - The request Succeeded. 
{
  "data": {
    "name": "vehicles"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 31 May 2024
Did this page help you?
Get state-machine configurtion of a participant type
Update an Entity