Asynchronous Execution

Description

Some of the administrative operations are very involved and take longer to complete. To prevent the client from blocking while the operation completes and to provide a progress report, these operations can be executed in an asynchronous manner by passing in the runAsync parameter in addition to the operational parameters.

When the operation is run in asynchronous mode, the system treats it as a job and returns a jobID back to the client immediately. The client can subsequently use the jobID to fetch status (progress) of the operation by using the jobs resource.

Request Parameters

Parameter

Details

runAsync

Description: A boolean to indicate if the operation needs to be run asynchronously.

Values: true | false. Default is false.

Response Format

{
	"status": "success",
	"jobid": "<jobID>"
}

12/1/2017