goalsmanagement.process.period.list

Scope: goalsmanagement

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

Справочник enum REPORTING_PERIOD процессов

HTTP: GET

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

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

Поля filter (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.

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/goalsmanagement.process.period.list.json" \
          -H "Accept: application/json"
        

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

{
          "result": {
            "result": [
              {
                "id": 127,
                "code": "3_month",
                "name": "Квартал (последний день квартала)"
              }
            ],
            "error": null,
            "next": null
          },
          "total": 1
        }
        

См. такжеСм. также

• goalsmanagement.process.list
• Коды ошибок