Запросить демо
Запросить демо
Документерра: руководство пользователя

[API] Получение статуса задачи управления проектом

Получение статуса задачи в рамках проекта.   После завершения задания сервер будет ждать от вас получения статуса, после чего задание будет завершено — т.е. на все последующие запросы к одному и тому же завершенному заданию будет выдаваться ошибка 404.

GET tasks/{task-key}

Авторизация

Этот запрос требует базовой авторизации.

Параметры запроса

Параметры пути
task-key
string
Ключ задачи, статус которой необходимо получить.

Образцы

Образец запроса
Bash (Unix Shell)
curl --location -g --request GET 'https://{portal-url}/api/v1/tasks/651db92f08d64dbd86b48c92d2aaf668'
Образец тела ответа
JSON
{
"isSucceeded": true,
"isWorking": false,
"maxOverallProgress": 100,
"overallProgress": 100,
"statusText": "Export finished.",
"taskName": "Exporting Publication"
}

Поля ответа

isSucceeded
Определяет, успешно или нет выполнена задача. Если задача еще не завершена, выдается null.
isWorking Определяет, находится ли задача в процессе выполнения.
maxOverallProgress
Максимальное значение прогресса выполнения данной задачи.
overallProgress
Текущий прогресс выполнения задачи. Вместе с maxOverallProgress может использоваться для расчета процента выполнения задачи.
statusText
Название текущего статуса задачи.
taskName
Название задачи.