goalsmanagement.process.list
Scope:
goalsmanagementКто может вызывать: ModuleUser::canViewProcess(). Подробнее: Права доступа
Список процессов оценки с Mongo-фильтром и пагинацией
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
limit |
int |
нет | Размер страницы, по умолчанию 50, максимум 500 |
offset |
int |
нет | Смещение, по умолчанию 0 |
fetchAll |
bool |
нет | Если true — вернуть все строки (лимит rest_fetch_all_max) |
filter |
object |
нет | Mongo-фильтр. Допустимые поля: id, sectionId, name, active, processDuration, settingGoals, alignmentGoals, settingRating, alignmentRating, reportingPeriod, finalGoals, maxPercent, dateStart, timeWindowGoals. Enum xmlId: processDuration=3_month|6_month|12_month; reportingPeriod=1_week|2_week|1_month|3_month|6_month (или числовой id) |
Поля filter (Mongo)
Поддерживаемые поля: id, sectionId, name, active, processDuration, settingGoals, alignmentGoals, settingRating, alignmentRating, reportingPeriod, finalGoals, maxPercent, dateStart, timeWindowGoals.
Операторы: $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin. Для enum-полей допускаются xmlId или числовой id значения.
Пагинация
limit (default 50, max 500), offset, fetchAll (защитный лимит записей, иначе FETCH_ALL_LIMIT_EXCEEDED).
Возвращаемые данные
Ответ в конверте модуля: result.result — массив элементов (массив процессов (id, name, периоды, флаги…) + 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.process.list.json" \
-H "Accept: application/json" \
--data-urlencode "limit=20" \
--data-urlencode "offset=0" \
--data-urlencode "filter[active][$eq]=Y"
Пример ответа
{
"result": {
"result": [
{
"id": 42,
"sectionId": 12,
"name": "Оценка целей 2026",
"active": "Y",
"processDuration": "12_month",
"settingGoals": 14,
"alignmentGoals": 7,
"settingRating": 10,
"alignmentRating": 5,
"reportingPeriod": "3_month",
"finalGoals": 7,
"maxPercent": 120,
"dateStart": "2026-01-01",
"timeWindowGoals": 30,
"isRun": true
}
],
"error": null,
"next": null
},
"total": 1
}