# assessment360.competency.category.list

Scope: assessment360

Кто может вызывать: Авторизованный пользователь REST. Подробнее: Права доступа

Возвращает список категорий компетенций с пагинацией и фильтром.

HTTP: GET

Побочные эффекты: none

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

Параметр Тип Обяз. Описание
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение
fetchAll bool нет Вернуть все записи одним ответом (максимум 5000; при превышении — FETCH_ALL_LIMIT_EXCEEDED)
filter object нет Фильтр в mongo-style формате

Поля filter (Mongo)

Поддерживаемые поля: id, name, active, parentId, sort, color.

Также поддерживаются алиасы: categoryId, sectionParentId, categoryParentId, parentSectionId, sectionSort, categorySort, orderIndex, categoryOrder.

Поля sort и color фильтруются пост-обработкой.

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

Ответ возвращается в конверте модуля: result.result — массив объектов категории (id, name, active, parentId, sort, color); result.next — смещение следующей страницы или null; result.error — ошибка или null; total — общее число записей.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера
INVALID_LIMIT Некорректное значение limit
INVALID_OFFSET Некорректное значение offset
INVALID_FILTER Некорректный фильтр
INVALID_FILTER_OPERATOR Неизвестный оператор фильтра

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/assessment360.competency.category.list.json"
          -H "Accept: application/json"
          --data-urlencode "limit=20"
          --data-urlencode "offset=0"
        

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

{
          "result": {
            "result": [
              {
                "id": 5,
                "name": "Soft skills",
                "active": true,
                "parentId": 0,
                "sort": 500,
                "color": "#FF5733"
              }
            ],
            "next": 20,
            "error": null
          },
          "total": 57
        }
        

См. также