Получение информации о задаче

07 декабря 2023

ID 199646

Позволяет получить информацию о задаче по ее идентификатору.

Метод:

GET /api/2.0/virtualization/tasks/{идентификатор}

где:

{идентификатор} – идентификатор задачи (обязательный параметр).

В случае успешного выполнения запроса REST API возвращает сведения о задаче в следующем виде:

<task id="{идентификатор}" created="{дата и время}" stateChanged="{дата и время}" changed="{дата и время}">

<state>{состояние}</state>

<type>{тип}</type>

<stage>{этап}</stage>

<progress>{процент выполнения}</progress>

<result>{результат}</result>

<!-- Если задача завершилась с ошибкой вместо результата отображается сообщение об ошибке. -->

<error>{сообщение об ошибке}</error>

</task>

где:

  • {идентификатор} – идентификатор задачи.
  • created="{дата и время}" – время создания задачи в формате YYYY-MM-DDThh:mm:ss.
  • stateChanged="{дата и время}" – время изменения состояния задачи в формате YYYY-MM-DDThh:mm:ss.
  • changed="{дата и время}" – время изменения задачи в формате YYYY-MM-DDThh:mm:ss.
  • {состояние} – состояние задачи.
  • {тип} – тип задачи. Например:
  • {название} – название задачи.
  • {этап} – этап выполнения задачи.
  • {процент выполнения} – ход выполнения задачи в процентах.
  • {результат} – результат выполнения задачи, например, информация о созданном клиенте или идентификатор отчета.
  • {сообщение об ошибке} – если в ходе выполнения задачи произошла ошибка, отображается сообщение об ошибке.

Коды возврата:

  • 200 (OK) – запрос выполнен успешно.
  • 403 (Forbidden) – доступ к ресурсу запрещен.
  • 404 (Not Found) – задача с указанным идентификатором не найдена в базе данных Сервера интеграции.

Вам помогла эта статья?
Что нам нужно улучшить?
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!