NEnexla
Async Tasks

Create an async operation.

Create an async operation. Returns the task id and other related data. Checks if the user has permission to create the task with all entities, and other preconditions.

post/async_tasks

Request

Request body

type'BulkDeleteNotifications' | 'BulkMarkAsReadNotifications' | 'BulkPauseFlows' | 'CallProbe' | 'ChownUserResources' | 'DeactivateUser' | 'GetAuditLogs'

The type of the task.

priorityinteger

The priority of the task. At the moment doesn't have any effect.

argumentsobject

The arguments for the task. Use GET /async_tasks/explain_arguments/{task_type} to get the list of possible arguments for task.

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.