Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.53 KB

AsyncActionBase.md

File metadata and controls

42 lines (26 loc) · 1.53 KB

AsyncActionBase

This is an object representing an asynchronous action.

Properties

Name Type Description
id String Async action unique ID.
type String Type of async action.
status StatusEnum Status of the async action. Informs you whether the async action has already been completed.
operationStatus String Status of async action processing. Informs about the async action status, whether it failed, succeeded, or the status is unknown.
createdAt OffsetDateTime Timestamp representing the date and time when the async action was scheduled in ISO 8601 format.
updatedAt OffsetDateTime Timestamp representing the date and time when the async action was updated. The value is shown in the ISO 8601 format.
requestId String Unique request ID.
processingTime Integer The length of time it took to process the request in milliseconds.
progress Integer % progress to completion of the asynchronous action.
_object ObjectEnum The type of the object represented by JSON. This object stores information about the `async_action`.

Enum: StatusEnum

Name Value
DONE "DONE"
ENQUEUED "ENQUEUED"
FAILED "FAILED"
IN_PROGRESS "IN_PROGRESS"

Enum: ObjectEnum

Name Value
ASYNC_ACTION "async_action"