Populate the instance with the default state

1min

POST
https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/{entityCode}/instance
This API will create an instance of the particular entity type with the default state machine configuration.
ParamterDescriptionTypeValidation
instanceId*Unique Id of the instance that needs to be onboarded with the state machine configuration.stringminLength: 1 maxLength: 64
stateThe default state of the instance to which it should be onboarded to. If not provided, then instance will be onboarded to default state mentioned in the state machine configuration.stringminLength: 3 maxLength: 64
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. |
| **503 - Server Errors** | Something went wrong on our end. (These are rare.) |
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
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/{entityCode}/instance' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "instanceId": ""
}'
curl --location --globoff 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/{entityCode}/instance' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "instanceId": ""
}'
Responses
200
400
401
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
`instanceId`*	Unique Id of the instance that needs to be onboarded with the state machine configuration.	string	minLength: 1 maxLength: 64
`state`	The default state of the instance to which it should be onboarded to. If not provided, then instance will be onboarded to default state mentioned in the state machine configuration.	string	minLength: 3 maxLength: 64
`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?

API to get list of orphan Reason Codes (not associated with any event code).

Get the current state of the instance