goalsmanagement.goalitem.list

Scope: goalsmanagement

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

Список целей внутри карточки (обязателен cardId)

HTTP: GET

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

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

Параметр Тип Обяз. Описание
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение, по умолчанию 0
fetchAll bool нет fetchAll flag
filter.cardId int да ID карточки целей (обязателен; top-level cardId also accepted)
filter object нет filter.cardId обязателен (также принимается top-level cardId). Другие поля — поля возвращаемого goal item

Поля filter (Mongo)

Поддерживаемые поля: cardId, id, goal, task, type_goal, criterion, commentGeneral, weight, file, depend, related, dateCreate, dateModify, createdBy, modifiedBy, cascadeSource, cascadeFrom, thisCascade, cascadeOnEmployees, cascadeOnBosses.

Операторы: $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 Пользователь не авторизован
VALIDATION_ERROR Некорректные или неполные параметры
ACCESS_DENIED Нет прав на операцию (общий запрет)
INVALID_FILTER Некорректный filter или неизвестное поле
INTERNAL_ERROR Внутренняя ошибка сервера

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

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

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

{
          "result": {
            "result": [
              {
                "id": "8",
                "goal": "1049",
                "task": "Заключить договоры с 20 новыми клиентами",
                "type_goal": "62",
                "criterion": "Рост выручки на 15%",
                "commentGeneral": "Согласовано с руководителем",
                "weight": "40",
                "file": "",
                "depend": ["2"],
                "related": [],
                "createdBy": "1",
                "modifiedBy": "1",
                "cascadeSource": "858",
                "cascadeFrom": "1",
                "thisCascade": "1",
                "cascadeOnEmployees": ["858"],
                "cascadeOnBosses": ["615"],
                "dateCreate": "28.07.2026 10:32:53",
                "dateModify": "28.07.2026 15:15:21"
              }
            ],
            "error": null,
            "next": null
          },
          "total": 1
        }
        

См. также