Update an Entity

1min
PUT
https://{tenantSubdomain}/core/api/v2/participants/config/state-machine/entities/{entityCode}
This API will update an entity. Events specified in the request will be replaced for the entity.
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
EntityUpdateRequest
*
Description
Update entity
description
string
*
events
string[]
*
isEnabled
boolean
Responses
200
OK - The request Succeeded.
SuccessResponse
data
NameResponse
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
*
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}/core/api/v2/participants/config/state-machine/entities/{entityCode}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "description": "",
  "events": [
    ""
  ]
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}/core/api/v2/participants/config/state-machine/entities/{entityCode}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "description": "",
  "events": [
    ""
  ]
}'
Responses
200
400
401
503
// OK - The request Succeeded. 
{
  "data": {
    "name": "vehicles"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK - The request Succeeded. 
{
  "data": {
    "name": "vehicles"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 31 May 2024
Did this page help you?
Update state machine configuration for a participant type
Get all events