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
EntityCode
*
instanceId
UniqueId
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Body Parameters
body
DestinationState
*
Description
Destination state for instace state transition.
state
string
*
subState
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
*
404
Not found - The server can not find the requested resource.
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
*
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/{entityCode}/instance/{instanceId}/state' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "state": ""
}'
curl --location --globoff --request PUT 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/{entityCode}/instance/{instanceId}/state' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "state": ""
}'
Responses
200
400
401
404
503
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {}
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {}
}
﻿
﻿

Paramter	Description	Type	Validation
`state`*	Represents the main state to which we want to override the instance.	string
`subState`	TSubstate is optional, if not specified then will be populated by the default substate of that main state.	string
`callback`	Represents callback url, which can be called to notify the status of API request.	string	pattern: A valid URL.
*This is required.

Code	Description
200 - OK	Everything worked as expected.

Updated 31 May 2024

Did this page help you?

Apply event on an instance.

Create new job