Get the current state of the instance

1min

GET
https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/{entityCode}/instance/{instanceId}
This API is to get the current state of the instance.
Header/Path/QueryDescriptionTypeValidation
X-COREOS-REQUEST-ID*(header)Unique request ID.string
entityType*(path)Name of an entity type.string
instanceId*(path)Unique id of an instance of the entity type.string
type(query)Type of state data to be returned.stringAvailable values: current, all
Default value: current
*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
Query Parameters
type
string
Responses
200
Instance State
InstanceStateGetResponse
error
Error
data
InstanceState
request
Request
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 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/{entityCode}/instance/{instanceId}?type=current' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/{entityCode}/instance/{instanceId}?type=current' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
503
// Instance State 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "data": {
    "id": "",
    "state": "",
    "event": {
      "eventCode": "",
      "reasonCode": "",
      "timestamp": {},
      "data": {},
      "source": {
        "appId": "",
        "userId": "",
        "locId": ""
      },
      "callback": ""
    }
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// Instance State 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "data": {
    "id": "",
    "state": "",
    "event": {
      "eventCode": "",
      "reasonCode": "",
      "timestamp": {},
      "data": {},
      "source": {
        "appId": "",
        "userId": "",
        "locId": ""
      },
      "callback": ""
    }
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

Header/Path/Query	Description	Type	Validation
`X-COREOS-REQUEST-ID`*(header)	Unique request ID.	string
`entityType`*(path)	Name of an entity type.	string
`instanceId`*(path)	Unique id of an instance of the entity type.	string
`type`(query)	Type of state data to be returned.	string	Available values: current, all Default value: current
*This is required.

Code	Description
200 - OK	Everything worked as expected.

Updated 31 May 2024

Did this page help you?

Populate the instance with the default state

Apply event on an instance.