Create events for a container-type

1min

POST
This API is for create events based on given details.
HTTP Status Code Summary
CodeDescription
201 - CreatedEverything 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 ErrorsSomething went wrong on our end. (These are rare.)
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*
Unique request id.
X-COREOS-TID
string
*
Example: delhivery1234
Tenant id
X-COREOS-ACCESS
string
*
Core-os access token
X-COREOS-USERINFO
string
Core-os user info
BODY PARAMETERS
body
EventCreateRequest
*
Create new State Machine Event.
description
string
*
Short description of the event. Max length 64 characters.
eventType
EventType
Specifies event is transitional or not

   - TRANSITIONAL - Transitonal event is an event that upon invocation it will change the state of the                         container.

   - NON_TRANSITIONAL - Transitonal event is an event that upon invocation it will not change the state of the                     container.
reasonCodes
string[]
Example: ["R-nnnn"]
List of valid reason codes that can raise this event code
containerTypeNames
string[]
List of containerTypeNames where this event can be applied
isEnabled
boolean
True - Event Code is valid & usable. False - Event Code is not usable
dataValidations
EventDataItem[]
Data expected along with the event and their respective validations, if any.
RESPONSES
201
Created
SuccessResponse
data
object
request
Request
400
Bad Request
ErrorResponse
error
Error
Error Information
request
Request
401
Unauthorized
ErrorResponse
error
Error
Error Information
request
Request
404
Not Found
ErrorResponse
error
Error
Error Information
request
Request
503
Server Error
ErrorResponse
error
Error
Error Information
request
Request
﻿
﻿

Code	Description
201 - Created	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 Errors	Something went wrong on our end. (These are rare.)

Updated 24 Aug 2023

Did this page help you?

Get all events

Update events for a container-type