State Machine Service
State Machine Config
Create a new state machine configuration
1min
POST
PATH PARAMETERS
entityCode
EntityCode
*Code of an entity.
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*Unique requestId
X-COREOS-TID
string
*Tenant id
X-COREOS-ACCESS
string
*core-os access token
X-COREOS-USERINFO
string
core-os user info token
BODY PARAMETERS
body
StateMachineRequest
*[All Of:StateMachineConfig]State-machine configuration for the entity type
states
States
*List of main states with its substates and transitions
terminalTTL
string
*Represents time to live of an instance in transactional database after it has reached a terminal state.
callback
CallbackURL
Represents callback url, which can be called to get any info about state transition of an instance or its terminal ttl expiry or to notify status of API request.
RESPONSES
200
OK
SuccessResponse
[All Of:ErrorResponseobject]error
Error
*Error Information
request
Request
*data
object
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
*Error Information
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
*Error Information
request
Request
*503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
*Error Information
request
Request
*
Updated 21 Sep 2023
Did this page help you?