validate state of an entity

1min
POST
https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/entities/{entityCode}/validate
This API will create an event with given event details.
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
EntityStateValidationRequest
*
Description
Validate an entity state
reasonCode
string
*
eventCode
string
*
state
string
*
Responses
200
OK
EntityStateValidationResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
data
object
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/entities/{entityCode}/validate' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "reasonCode": "",
  "eventCode": "",
  "state": ""
}'
curl --location --globoff 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/entities/{entityCode}/validate' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "reasonCode": "",
  "eventCode": "",
  "state": ""
}'
Responses
200
400
401
503
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "valid": false
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "valid": false
  }
}
﻿
﻿
Code	Description
200 - OK	Everything worked as expected.
Updated 31 May 2024
Did this page help you?
Get an Entity
Get all events