Update an Entity

1min

PUT
This API will update an entity. Events mentioned in the events list will be replaced for the entity
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
*
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
SuccessResponse
data
object
request
Request
400
Bad Request
ErrorResponse
error
Error
request
Request
401
Unauthorized
ErrorResponse
error
Error
request
Request
404
Not Found
ErrorResponse
error
Error
request
Request
503
Server Error
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/containers/config/state-machine/entities/{entityCode}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "description": "",
  "events": [
    ""
  ]
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/containers/config/state-machine/entities/{entityCode}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "description": "",
  "events": [
    ""
  ]
}'
Responses
200
400
401
404
503
// OK 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

Code	Description
200 - OK	Everything worked as expected.

Updated 24 Aug 2023

Did this page help you?

Update state machine configuration of container type

Get all events