goalsmanagement.goalcard.status.list
Scope:
goalsmanagementКто может вызывать: Авторизованный пользователь. Подробнее: Права доступа
Справочник статусов карточки целей (USER_GOAL_STATUS)
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
filter |
object |
нет | Mongo-фильтр |
Поля filter (Mongo)
Поддерживаемые поля: id, code, name.
Операторы: $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin. Для enum-полей допускаются xmlId или числовой id значения.
Возвращаемые данные
Ответ в конверте модуля: result.result — массив {id, code, name}; result.error. Ключи total/next для не-list методов могут отсутствовать в сериализации, если не переданы.
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
INVALID_FILTER |
Некорректный filter или неизвестное поле |
INTERNAL_ERROR |
Внутренняя ошибка сервера |
Пример запроса (GET)
curl -G "https://{портал}/rest/{user_id}/{webhook_code}/goalsmanagement.goalcard.status.list.json" \
-H "Accept: application/json"
Пример ответа
{
"result": {
"result": [
{
"id": 3,
"code": "status_approval",
"name": "На согласовании"
}
],
"error": null,
"next": null
},
"total": 1
}
См. также
Предыдущая
Следующая