Async Tasks

Acknowledge async operation

Acknowledge an async operation. This is used to confirm that the user has seen the results of the async operation. After that, if tasks has stored results, they will be deleted.

post/async_tasks/{task_id}/acknowledge

Request

Path parameters

task_idinteger required

The task id.

Headers

Accept'application/vnd.nexla.api.v1+json' | 'application/json'

Setting to application/vnd.nexla.api.v1+json is recommended.

Response

Success

idstring

The unique identifier of the task.

type'BulkDeleteNotifications' | 'BulkMarkAsReadNotifications' | 'BulkPauseFlows' | 'CallProbe' | 'ChownUserResources' | 'DeactivateUser' | 'GetAuditLogs'
status'pending' | 'running' | 'completed' | 'failed' | 'cancelled'

The status of the task.

progressinteger

The progress of the task.

priorityinteger

The priority of the task.

created_atstring date-time

The date and time the task was created.

stopped_atstring date-time

The date and time the task was completed, failed or stopped in another way.

resultobject

The result of the task.

result_urlstring

The URL to the result of the task.

errorobject

The error that occurred during the task.

Changes

No recorded changes to this operation across all 1 revision of this API.