[POST] .../v1/filter/getfields
Возвращает список полей, которые можно передавать в filters[].field для выбранной сущности.
Ответ зависит от entity_type и настроек аккаунта. В список могут входить стандартные поля сущности и пользовательские дополнительные поля (field_*), если они доступны для этой сущности.
Входные параметры
| Название | Тип данных | Обязательность | Описание |
|---|---|---|---|
| entity_type | Enum (FieldEntityTypeEnum) |
Обязательный | Сущность, для которой нужно вернуть список полей фильтрации. |
Поддерживаемые значения: RetailCustomer, Partner, Item, DocPurchase, DocPayment, DocAccountMovement, Task, Lead, Deal, Client, Ticket.
Пример запроса
{
"entity_type": "Item"
}Выходные параметры
| Название | Тип данных | Описание |
|---|---|---|
| result | Array of Object | Массив полей для фильтрации в формате { field, datatype }. |
| result[].field | String | Имя поля, доступного для фильтрации. |
| result[].datatype | String | Тип данных поля: string, int, decimal, bool. |
Пример ответа
{
"ok": true,
"result": [
{ "field": "icps", "datatype": "string" },
{ "field": "articul", "datatype": "string" },
{ "field": "price", "datatype": "decimal" },
{ "field": "quantity.common", "datatype": "decimal" },
{ "field": "field_telegram_id", "datatype": "string" }
]
}