Methods for working with tasks

The tasks are used for processing requests that are time consuming and run asynchronously. Task statuses allow you to monitor the progress of actions specified in the request.

A task may have one of the following states:

• Created – task is created but not started.
• Starting – the task is in the process of starting.
• Running – the task is running. For a task in this state, the execution progress is displayed as a percent value.
• Completed – the task has been successfully completed. For a task in this state, the task execution result is displayed. The result contains task-specific data, for example, the new tenant identifier when the CreateTenant task is completed.
• Stopping – the task is being prepared for completion. If you stopped a task, it may be in this state before switching to the Canceled state.
• Failed – the task failed. For a task in this state, detailed error information is indicated.
• Canceled – the task is terminated by the user or the system. For a task in this state, detailed error information is indicated.
• Queued – the task has been queued and is waiting for execution to start.

By means of the Integration Server REST API, you can perform the following tasks:

• Get a list of tasks
• Get information about a specified task
• Cancel execution of a specified task