State Machine Service
Instance State

Change the current state of an instance.

1min
PUT
https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/{entityCode}/instance/{instanceId}/state

This API will override the current state of an instance without applying any events to it.

ParamterDescriptionTypeValidation
state*Represents the main state to which we want to override the instance.string
subStateTSubstate is optional, if not specified then will be populated by the default substate of that main state.string
callbackRepresents callback url, which can be called to notify the status of API request.stringpattern: A valid URL.
*This is required.

HTTP Status Code Summary

CodeDescription
200 - OKEverything worked as expected.
| **400 - Bad Request** | The request was unacceptable, often due to missing a required parameter. |
| **401 - Unauthorized** | No valid API key provided. |
| **404 - Not Found** | The requested resource doesn't exist. |
| **503 - Server Errors** | Something went wrong on our end. (These are rare.) |
Path Parameters
entityCode
*
instanceId
*
Header Parameters
X-COREOS-REQUEST-ID
*
X-COREOS-TID
*
X-COREOS-ACCESS
*
X-COREOS-USERINFO
Body Parameters
body
*
Description
Destination state for instace state transition.
state
*
subState
callback
Responses
200
OK
All Of
ErrorResponse +
error
*
request
*
data
All Of
Instance +
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
error
*
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.
error
*
request
*
404
Not found - The server can not find the requested resource.
error
*
request
*
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
error
*
request
*
Curl
JS
Ruby
Python
Responses
200
400
401
404
503