ipr.position.list

Scope: ipr

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

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

HTTP: GET

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

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

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

Поля filter (Mongo)

Поле API Соответствие
id ID элемента
title NAME
active ACTIVE (по умолчанию Y)
sectionId Раздел каталога должностей (SECTION_ID)
code Символьный код (CODE)

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

Массив объектов:

Поле Тип Описание
id int ID должности
title string Название
active bool ACTIVE = Y
sectionId int|null Раздел каталога
level string|null Грейд/уровень должности
requiredCompetenceIds int[] ID обязательных компетенций каталога
recommendedCompetenceIds int[] ID рекомендованных компетенций каталога

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера (в т. ч. каталог должностей не настроен)
INVALID_LIMIT / LIMIT_EXCEEDED / INVALID_OFFSET / INVALID_FILTER / INVALID_FILTER_OPERATOR Некорректные параметры пагинации/фильтра
FETCH_ALL_LIMIT_EXCEEDED Превышен лимит fetchAll

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

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

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

{
          "result": {
            "result": [
              {
                "id": 305,
                "title": "Ведущий аналитик",
                "active": true,
                "sectionId": 4,
                "level": "senior",
                "requiredCompetenceIds": [1049, 1051],
                "recommendedCompetenceIds": [1052]
              }
            ],
            "total": 1,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
Обзор раздела
Следующая
ipr.position.get