goalsmanagement.goalcard.list
Scope:
goalsmanagementКто может вызывать: Авторизованный; выборка с учётом canViewControl / видимости. Подробнее: Права доступа
Список карточек целей с Mongo-фильтром публичной гриды
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
limit |
int |
нет | Размер страницы, по умолчанию 50, максимум 500 |
offset |
int |
нет | Смещение, по умолчанию 0 |
fetchAll |
bool |
нет | Если true — вернуть все строки (лимит rest_fetch_all_max) |
filter |
object |
нет | Mongo-фильтр карточек целей (см. отдельные filter.* в schema) |
filter.id |
int |
нет | Card ID |
filter.status |
string |
нет | Статус: xmlId или id enum |
filter.dateStart |
string |
нет | Дата начала процесса |
filter.dateEnd |
string |
нет | Дата окончания процесса |
filter.employeeId |
int |
нет | ID сотрудника |
filter.departmentId |
int |
нет | Department section ID |
filter.statusProcess |
string |
нет | Статус процесса отдела 0|1 |
filter.needAction |
bool |
нет | Карточки, требующие действия текущего пользователя |
Поля filter (Mongo)
Поддерживаемые поля: id, status, dateStart, dateEnd, 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.goalcard.list.json" \
-H "Accept: application/json" \
--data-urlencode "limit=20" \
--data-urlencode "offset=0" \
--data-urlencode "filter[departmentId][$eq]=12"
Пример ответа
{
"result": {
"result": [
{
"id": 501,
"needAction": true,
"name": "Карта целей: Иван Петров",
"active": "Y",
"employeeId": 15,
"headId": 8,
"directorId": 3,
"delegateId": 16,
"status": "status_approval",
"deadline": "2026-08-15",
"goals": [
{
"ID": 1001,
"GOALS_TABLE_GOAL_ID": 101,
"GOALS_TABLE_GOAL": "Увеличить выручку отдела",
"GOALS_TABLE_TASK": "Заключить договоры с 20 новыми клиентами",
"GOALS_TABLE_TYPE_GOAL": "Стратегическая",
"GOALS_TABLE_CRITERION": "Рост выручки на 15%",
"GOALS_TABLE_COMMENT_GENERAL": "Согласовано с руководителем",
"GOALS_TABLE_WEIGHT": 40,
"GOALS_TABLE_PROGRESS": 65
}
],
"totalProgress": 65,
"dateStart": "2026-01-01",
"dateEnd": "2026-12-31",
"position": "Менеджер по продажам",
"departmentId": 12,
"deadlineFilling": "2026-01-20",
"deadlineApproval": "2026-01-31",
"processDuration": "12_month",
"reportingPeriod": "3_month",
"statusProcess": "1",
"processId": 42
}
],
"error": null,
"next": null
},
"total": 1
}