assessment360.export.start

Scope: assessment360

Кто может вызывать: Группы «могут выгружать оценки» (canExportAssessment). См. Права доступа

Запускает асинхронную выгрузку результатов оценки.

HTTP: POST

Побочные эффекты: Изменяет состояние данных модуля assessment360.

Контекст экспорта привязан к текущему пользователю REST (для вебхука — {user_id} в URL). Последующие export.status и export.download без параметров читают именно этот последний запуск того же пользователя; exportId не выдаётся.

Параметры метода

Параметр Тип Обяз. Описание
format string да Формат выгрузки: csv или excel
dataset string да Набор данных: competencies или indicators (алиас: scope)
columns object да Набор колонок выгрузки (см. ниже)
exportOptions object нет Legacy-алиас параметра columns

Структура columns

Объект с только перечисленными ключами (значение — bool). Хотя бы один ключ должен быть true. Неизвестные ключи игнорируются.

Ключ Тип Описание
AVG bool Средняя оценка
AVG_WITHOUT_SELF bool Средняя без самооценки
SELF bool Самооценка
MANAGER bool Оценка руководителя
FINAL bool Итоговая оценка

Параметр exportOptions принимает ту же структуру и используется как альтернатива columns, если columns не передан.

Возвращаемые данные

Тот же объект статуса, что и у assessment360.export.status: поля initialized, format, dataset, columns, processed, totalCount, isCompleted.

Логические состояния (нет активного экспорта / в процессе / завершён) и таблица полей — в документе export.status. Ответ в конверте модуля: result.result, result.error.

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера
ACCESS_DENIED Экспорт недоступен текущему пользователю
VALIDATION_ERROR Некорректный format, dataset/scope или columns (нет ни одной включённой колонки)

Пример запроса (POST)

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/assessment360.export.start.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{
          "format": "csv",
          "dataset": "competencies",
          "columns": {
            "AVG": true,
            "AVG_WITHOUT_SELF": true,
            "SELF": true,
            "MANAGER": true,
            "FINAL": true
          }
        }'

Пример ответа

{
          "result": {
            "result": {
              "initialized": true,
              "format": "csv",
              "dataset": "competencies",
              "columns": {
                "AVG": true,
                "AVG_WITHOUT_SELF": true,
                "SELF": true,
                "MANAGER": true,
                "FINAL": true
              },
              "processed": 42,
              "totalCount": 42,
              "isCompleted": true
            },
            "error": null
          }
        }

См. также

Предыдущая
Обзор раздела
Следующая
assessment360.export.status