assessment360.export.status
Scope:
assessment360Кто может вызывать: Авторизованный пользователь REST: статус своего последнего экспорта (отдельной проверки группы выгрузки нет). См. Права доступа
Возвращает статус выполнения экспорта.
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| — | — | — | Нет параметров |
Параметров нет намеренно: метод смотрит на последний экспорт текущего пользователя (тот же userId, от имени которого вызван REST — для вебхука это {user_id} в URL). Отдельного exportId / jobId нет. У разных пользователей контексты независимы.
Возвращаемые данные
Объект статуса экспорта в конверте модуля: result.result, result.error.
Отдельного строкового поля status нет: состояние вычисляется по флагам initialized и isCompleted.
Поля объекта статуса
| Поле | Тип | Описание |
|---|---|---|
initialized |
bool |
true, если для текущего пользователя был вызван export.start (есть сохранённая сессия экспорта) |
format |
string | null |
Формат выгрузки: csv или excel; null, если экспорт ещё не запускался |
dataset |
string | null |
Набор данных: competencies или indicators; null, если экспорт ещё не запускался |
columns |
object |
Флаги колонок (AVG, AVG_WITHOUT_SELF, SELF, MANAGER, FINAL); пустой объект {}, если экспорт не запускался |
processed |
int |
Сколько строк уже обработано |
totalCount |
int |
Всего строк к выгрузке |
isCompleted |
bool |
true, когда обработка завершена и файл можно скачать через export.download |
Логические состояния экспорта
| Состояние | initialized |
isCompleted |
Смысл | Что делать |
|---|---|---|---|---|
| Нет активного экспорта | false |
false |
Сессии нет (или после очистки) | Вызвать assessment360.export.start |
| В процессе | true |
false |
Экспорт запущен, файл ещё не готов | Повторять export.status, пока isCompleted не станет true |
| Завершён | true |
true |
Файл готов | Вызвать assessment360.export.download |
Примечание: export.start в текущей реализации обычно доводит выгрузку до конца в одном запросе (isCompleted: true уже в ответе start). export.status нужен для проверки сохранённого состояния и повторного опроса, если isCompleted ещё false.
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
INTERNAL_ERROR |
Внутренняя ошибка сервера |
ACCESS_DENIED |
Экспорт недоступен текущему пользователю |
Пример запроса (GET)
curl -G "https://{портал}/rest/{user_id}/{webhook_code}/assessment360.export.status.json"
-H "Accept: application/json"
Пример ответа
{
"result": {
"result": {
"initialized": true,
"format": "csv",
"dataset": "competencies",
"columns": { "AVG": true, "SELF": true, "MANAGER": true, "FINAL": true },
"processed": 42,
"totalCount": 42,
"isCompleted": true
},
"error": null
}
}