Apply Event to the entity instance

1min
PUT
https://{tenantSubdomain}.io/core/api/v2/entity/{entityTypePluralName}/{entityId}/event
API will apply an event to an instance. If the event is transitionable, then the instance will transition to the particular state. Otherwise it will remain in the existing state
Path Parameters
entityTypePluralName
EntityTypePluralName
*
entityId
UniqueInstanceId
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-APPID
string
*
Body Parameters
body
InstanceStateUpdateRequest
*
Description
Event for instance of an entity type for state transition.
All Of
Event  +
eventCode
EventCode
*
reasonCode
ReasonCode
timestamp
object
All Of
EpochTimestamp  +
data
object
source
EventSource
callback
CallbackForInstance
Responses
202
OK
SuccessResponse
data
object
*
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
*
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/entity/{entityTypePluralName}/{entityId}/event' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "eventCode": "",
  "source": {
    "appId": ""
  }
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/entity/{entityTypePluralName}/{entityId}/event' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "eventCode": "",
  "source": {
    "appId": ""
  }
}'
Responses
202
400
401
404
// OK 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 16 Oct 2024
Did this page help you?
Create a new Template