Allows you to get information about the task by its identifier.
Method:
GET /api/2.0/virtualization/tasks/{ID}
where:
{ID} – task identifier (required parameter).
In case of successful completion of the request, the REST API returns the following information about the task:
<task id="{ID}" created="{date and time}" stateChanged="{date and time}" changed="{date and time}">
<state>{state}</state>
<type>{type}</type>
<stage>{stage}</stage>
<progress>{execution progress}</progress>
<result>{result}</result>
<!-- If the task execution fails, an error message is displayed instead of the result.
<error>{error message}</error>
</task>
where:
{ID} – task ID.created="{date and time}" – task creation time in YYYY-MM-DDThh:mm:ss format.stateChanged="{date and time}" – time of the task state change in YYYY-MM-DDThh:mm:ss format.changed="{date and time}" – task change time in YYYY-MM-DDThh:mm:ss format.{state} – task state.{type} – task type. For example:CreateTenant – a task that is used in the tenant creation procedure.ChangeTenantActivation – a task that is used in the tenant activation and deactivation procedures.DeleteTenant – a task that is used in the tenant deletion procedure.CreateTenantReport – a task that is used in the tenant protection report generation procedure.{name} – task name.{stage} – task execution stage.{execution progress} – the progress of task execution indicated as a percentage.{result} – task execution result, for example, information about the created tenant or report identifier.{error message} – if an error occurs during task execution, an error message is displayed.Return codes:
200 (OK) – request completed successfully.403 (Forbidden) – access to the resource is denied. 404 (Not Found) – task with the specified identifier is not found in the Integration Server database.