Provides details on a long running (asynchronous) operation. Some API methods such as for adding new documents to a project are executed asynchronously. The method returns an ID to the user. The user can then periodically poll the system until the operation has terminated.The present record contains such information on an operation.
| Child pages (Children Display) |
|---|
FORMAT
| Code Block | ||
|---|---|---|
| ||
<ApiAsyncOperation xmlns="http://schemas.datacontract.org/2004/07/Wordbee.Database"> <OperationId>2147483647</OperationId> <Status_>255</Status_> <Title>String content</Title> <ErrorMessage>String content</ErrorMessage> <PersonId>2147483647</PersonId> <CreationDate>1999-05-31T11:20:00</CreationDate> <ExecutionStartDate>1999-05-31T11:20:00</ExecutionStartDate> <ExecutionEndDate>1999-05-31T11:20:00</ExecutionEndDate> <ProgressStatus>String content</ProgressStatus> </ApiAsyncOperation> |
...
PROPERTIES
OperationId | Unique id of asynchronous operation |
Status | Status of operation: /// <summary> /// Result error during request execution /// </summary>Failed summary> Failed = 10, /// <summary> /// Request is waiting in queue for execution /// </summary>Waiting summary> Waiting = 0, /// <summary> /// Request is executing mode /// </summary>Executing summary> Executing = 1, /// <summary> /// Execution of request is finished /// </summary>Finished summary> Finished = 2 |
Title | Description of operation |
ErrorMessage | Set in case of a failed operation |
PersonId | The person who submitted the operation. |
CreationDate | Date of submission of operation request. |
ExecutionStartDate | Date when the operation was started. |
ExecutionEnndDate | Date when the operation successfully completed. Empty if operation not started, in progress or failed. |
ProgressStatus | A subset of operations provides operation progress details. |