Получение фильтров Варианта Отчета

GET /iapi_reports/form/?uid=<Идентификатор ВариантаОтчета>

GET параметр uid должен быть равен uid конкретного отчета полученного в методе report_list

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа в формате json:

{
  "view": "<Наименование отчета>",
  "entity_view": "Отчет.IAPI_ВариантОтчета",
  "system_name": "Отчет.IAPI_ВариантОтчета",
  "uid": "<uid запрошенного отчета>",
  "fields": [ <Массив полей фильтров> ],
  "version": "3.0",
  "iapi_version": "<Версия расширения IAPI>"
}

Поля фильтров бывают следующих типов:

text

Фильтр типа "Строка" ("Текст").

{
  "type": "text",
  "system_name": "<Системное имя фильтра, назначенное системой 1С>",
  "view": "<Отображаемое имя фильтра>",
  "value": "<Значение фильтра по умолчанию. Может быть null>"
}
number

Фильтр типа "Число". Может быть как целым так и дробным числом.

{
  "type": "number",
  "system_name": "<Системное имя фильтра, назначенное системой 1С>",
  "view": "<Отображаемое имя фильтра>",
  "value": <Значение фильтра по умолчанию. Либо число либо null>
}
boolean

Фильтр Логического типа. Принимает значения "true"/"false".

{
  "type": "boolean",
  "system_name": "<Системное имя фильтра, назначенное системой 1С>",
  "view": "<Отображаемое имя фильтра>",
  "value": <Значение фильтра по умолчанию. Либо true либо false>
}
date

Фильтр типа "Дата".

{
  "type": "date",
  "system_name": "<Системное имя фильтра, назначенное системой 1С>",
  "view": "<Отображаемое имя фильтра>",
  "value": "<Значение фильтра по умолчанию. ISO формат либо null>"
}
period_date

Фильтр типа "Период".

{
  "type": "period_date",
  "system_name": "<Системное имя фильтра, назначенное системой 1С>",
  "view": "<Отображаемое имя фильтра>",
  "value": {
    "start_date": "<ISO формат даты>",
    "end_date": "<ISO формат даты>",
  } <Либо null>
}
link

Фильтр типа "Ссылка на объект".

{
  "type": "link",
  "system_name": "<Системное имя фильтра, назначенное системой 1С>",
  "view": "<Отображаемое имя фильтра>",
  "linked_object_type": "<Тип объекта для получения [списка объектов](object_list.md)>"
  "value": {
    "view": "<Визуальное наименование объекта>",
    "uid": "<Уникальный идентификатор в системе 1С>",
  } <Либо null>
}
link_list

Фильтр типа "Список ссылок на объект".

{
  "type": "link_list",
  "system_name": "<Системное имя фильтра, назначенное системой 1С>",
  "view": "<Отображаемое имя фильтра>",
  "linked_object_type": "<Тип объекта для получения [списка объектов](object_list.md)>"
  "value": [
    {
      "view": "<Визуальное наименование объекта>",
      "uid": "<Уникальный идентификатор в системе 1С>",
    }
  ]
}

Если GET параметр uid указан неверно API возвращает ответ с кодом 500 и описание ошибки в текстовом формате.

В случае ошибки авторизации API возвращает ответ с кодом 401.