Apply event on the container.

1min

PUT
This 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.
PARAMETERDESCRIPTIONTYPEVALIDATION
name*Represents name of the event for state transition.stringminLength: 3 maxLength: 64
timestampRepresents the timestamp of the event occured.integer
propagatePropagate flag indicates whether these events need to propagate on child containers or not.booleanDefault: false
dataRepresents event data values, if any, for this event.
sourceRepresents the source which triggered the event. It can be an app, a user or some location from where the event was triggered.
ㅤ↳appId*Application ID which is responsible for calling this event.stringminLength: 1 maxLength: 64
ㅤ↳userIdUser ID which is responsible for calling this event.stringminLength: 1 maxLength: 64
ㅤ↳locIdLocationId of the event.string
callbackRepresents callback URL, which can be called to get any info about state change of a container and notify status(success/failed) of API.stringA valid URL.
*This is required.
HTTP Status Code Summary
CodeDescription
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
404 - Not FoundThe requested resource doesn't exist.
503 - Server ErrorSomething went wrong.. (These are rare.)
Path Parameters
containerId
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-CALLBACK-SECRET
string
X-COREOS-USERINFO
string
Body Parameters
body
ContainerStateUpdateRequest
*
Description
Event for container state transition.
eventCode
EventCode
*
reasonCode
ReasonCode
timestamp
integer
*
propagate
boolean
data
object
*
source
EventSource
*
callback
object
Responses
200
OK
ContainerStateResponse
data
ContainerState
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/{containerId}/state/event' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "eventCode": "",
  "timestamp": 0,
  "data": {},
  "source": {
    "appId": ""
  }
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/containers/{containerId}/state/event' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "eventCode": "",
  "timestamp": 0,
  "data": {},
  "source": {
    "appId": ""
  }
}'
Responses
200
400
401
404
503
// OK 
{
  "data": {
    "id": "123e4567-e89b-42d3-a456-556642440000"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "data": {
    "id": "123e4567-e89b-42d3-a456-556642440000"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

PARAMETER	DESCRIPTION	TYPE	VALIDATION
`name`*	Represents name of the event for state transition.	string	minLength: 3 maxLength: 64
`timestamp`	Represents the timestamp of the event occured.	integer
`propagate`	Propagate flag indicates whether these events need to propagate on child containers or not.	boolean	Default: false
`data`	Represents event data values, if any, for this event.
`source`	Represents the source which triggered the event. It can be an app, a user or some location from where the event was triggered.
ㅤ↳`appId`*	Application ID which is responsible for calling this event.	string	minLength: 1 maxLength: 64
ㅤ↳`userId`	User ID which is responsible for calling this event.	string	minLength: 1 maxLength: 64
ㅤ↳`locId`	LocationId of the event.	string
`callback`	Represents callback URL, which can be called to get any info about state change of a container and notify status(success/failed) of API.	string	A valid URL.
*This is required.

HTTP Status Code Summary

Code	Description
200 - OK	Everything 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 Error	Something went wrong.. (These are rare.)

Updated 24 Aug 2023

Did this page help you?

Get the current state of a container