put https://delhivery.preprod.fxtrt.io/core/api/v2/containers///state/event
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.
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.) |