State Machine Service
Instance State
Populate the instance with the default state
1min
POST
https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/{entityCode}/instance
Path Parameters
entityCode
EntityCode
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Body Parameters
body
InstanceOnboardRequest
*
Description
Onboard an instance of the entity type with default state
instanceId
string
*
state
string
callback
ApiCallbackURL
Responses
200
OK
InstanceSuccessResponse
All Of
ErrorResponse +
error
Error
*
request
Request
*
data
InstanceCDC
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.
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
*
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
*
request
Request
*
Updated 31 May 2024
Did this page help you?