Get

[POST] …/v1/Field/Get

Возвращает информацию о дополнительных полях.

Входные параметры

Название Тип данных Обязательность Описание
ids array of int64 Необязательный Массив id полей
keys array of string Необязательный Массив ключей (key) полей
entity_type enum Необязательный Сущность, к которой привязано поле. Допустимые значения: RetailCustomer
sort_orders array of SortOrders Необязательный Сортировка выходных параметров (по id, key, name)
search string Необязательный Строка поиска по полям name и key
required Boolean Необязательный Фильтр по обязательности поля: true — обязательные, false — необязательные, null — все
limit Int32 Необязательный Лимит возвращаемых данных при запросе.
offset Int32 Необязательный Смещение от начала выборки


SortOrders

Модель сортировки выходных параметров

Название Тип данных Описание
column enum Значение для сортировки: <Id> (Id поля), <Key> (Ключ поля), <Name > (Наименование)
direction enum Порядок сортировки: <ASC> (по возрастанию), <DESC> (по убыванию)

Пример запроса

{
  "ids": [101],
  "keys": ["customer_vat"],
  "entity_type": "RetailCustomer",
  "sort_orders": [
    {
      "column": "Key",
      "direction": "asc"
    }
  ],
  "search": "vat",
  "required": null,
  "limit": 20,
  "offset": 0
}

Выходные параметры

Название Тип данных Описание
result array of Field Массив дополнительных полей
next_offset Int32 Смещение для следующей выборки данных
total Int32 Количество элементов выборки

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

{
  "ok": true,
  "result": [
    {
      "id": 101,
      "key": "field_customer_vat",
      "name": "ИНН клиента",
      "entity_type": "RetailCustomer",
      "data_type": "string",
      "is_custom": true,
      "required": false
    }
  ],
  "next_offset": 0,
  "total": 1
}