goalsmanagement.ratingcard.list

Scope: goalsmanagement

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

Список карточек оценки с Mongo-фильтром публичной гриды

HTTP: GET

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

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

Параметр Тип Обяз. Описание
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение, по умолчанию 0
fetchAll bool нет fetchAll flag
filter.id int нет ID карточки оценки
filter.status string нет Статус: xmlId или id enum
filter.dateStart string нет Period start date
filter.dateEnd string нет Period end date
filter.dateCreate string нет Card create date
filter.employeeId int нет ID сотрудника
filter.departmentId int нет Department section ID
filter.statusProcess string нет Статус процесса отдела 0|1
filter.needAction bool нет Карточки, требующие действия текущего пользователя

Поля filter (Mongo)

Поддерживаемые поля: id, status, dateStart, dateEnd, dateCreate, employeeId, departmentId, statusProcess, needAction.

Операторы: $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin. Для enum-полей допускаются xmlId или числовой id значения.

Пагинация

limit (default 50, max 500), offset, fetchAll (защитный лимит записей, иначе FETCH_ALL_LIMIT_EXCEEDED).

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

Ответ в конверте модуля: result.result — массив элементов (массив карточек оценки + total); result.next — смещение следующей страницы или null; result.error; верхнеуровневый Bitrix total — общее число записей.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Нет прав на операцию (общий запрет)
INVALID_LIMIT limit вне диапазона 1..500
INVALID_OFFSET offset < 0
INVALID_FILTER Некорректный filter или неизвестное поле
INVALID_FILTER_OPERATOR Неизвестный оператор фильтра
FETCH_ALL_LIMIT_EXCEEDED При fetchAll=true подходящих записей больше защитного лимита (по умолчанию 5000)
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/goalsmanagement.ratingcard.list.json" \
          -H "Accept: application/json" \
          --data-urlencode "limit=20" \
          --data-urlencode "offset=0" \
          --data-urlencode "filter[employeeId][$eq]=15"
        

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

{
          "result": {
            "result": [
              {
                "id": 701,
                "needAction": true,
                "dateCreate": "2026-07-01 10:00:00",
                "status": "status_approval",
                "deadline": "2026-07-31",
                "ratings": [
                  {
                    "ID": 9001,
                    "RATING_TABLE_GOAL_ID": 101,
                    "RATING_TABLE_GOAL": "Увеличить выручку отдела",
                    "RATING_TABLE_TYPE_GOAL": "Стратегическая",
                    "RATING_TABLE_WEIGHT": 40,
                    "RATING_TABLE_PROGRESS": 65,
                    "RATING_TABLE_COMMENT_EMPLOYEE": "План выполнен на 65%",
                    "RATING_TABLE_COMMENT_HEAD": "Результат подтверждён"
                  }
                ],
                "dateStart": "2026-04-01",
                "dateEnd": "2026-06-30",
                "totalProgress": 65,
                "position": "Менеджер по продажам",
                "departmentId": 12,
                "deadlineFilling": "2026-07-15",
                "deadlineApproval": "2026-07-31",
                "processDuration": "12_month",
                "reportingPeriod": "3_month",
                "statusProcess": "1",
                "employeeId": 15,
                "goalCardId": 501
              }
            ],
            "error": null,
            "next": null
          },
          "total": 1
        }
        

См. также