Deferred Action Status

此内容尚不支持你的语言。

Certain actions triggered by API takes a long time. Instead of waiting for the task to complete, Teapplix may return a “DeferredActionID”.

You can get a callback from Teapplix when the action completes, or you can call the “DeferredAction” api to query the status:

GET

https://api.teapplix.com/api2/DeferredAction Explorer

Property	Type	Description	Constraints
`DeferredActionID`	string	Deferred Action ID

Property	Type	Description	Constraints
`Status`	string	Operation status	RequiredOne of: Success, Failure
`Messages`	string[]	Messages related to the this request
`DeferredAction`	Deferred Action Details	List of deferred action details

List of deferred action details

Property	Type	Description	Constraints
`ID`	integer	ID	Required
`Name`	string	Action Name	Required
`AddedTime`	string	Timestamp when action was added
`StartedTime`	string	Timestamp when action execution was started
`FinishedTime`	string	Timestamp when action execution was finished
`Status`	string	Status of the action	One of: new, queued, working, success, fail, stopped
`Result`	boolean	Result of the finished action
`Comment`	boolean	Comments to the action result or any other text data

Property	Type	Description	Constraints
`Success`	boolean	Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status.	Required
`Code`	integer	Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115
`Message`	string	Message typically associated with errors
`Description`	string[]	Detailed description

Property	Type	Description	Constraints
`Success`	boolean	Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status.	Required
`Code`	integer	Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115
`Message`	string	Message typically associated with errors
`Description`	string[]	Detailed description

Property	Type	Description	Constraints
`Success`	boolean	Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status.	Required
`Code`	integer	Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115
`Message`	string	Message typically associated with errors
`Description`	string[]	Detailed description

Property	Type	Description	Constraints
`Success`	boolean	Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status.	Required
`Code`	integer	Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115
`Message`	string	Message typically associated with errors
`Description`	string[]	Detailed description

URL APIToken Body