03-12-2018 23:59

Получение полей сущности для фильтрации в отчете по Заявкам

GET   /bs-core/reports/loan-apps/filters/fields/{className}

Метод используется для получения списка полей сущности, которые доступны для фильтрации данных в отчете "Отчет по заявкам".

Запрос

GET /bs-core/reports/loan-apps/filters/fields/com.pq.establ.dict.LeadEmul
Описание параметров
Параметр Обязателен Тип данных Описание
className R [string]

Название класса сущности (поле object ) полученное из метода "Получение сущностей для фильтрации в отчете по Заявкам".

Ответ


                        {
    "status": "ok",
    "timestamp": 1543509507793,
    "data": [
        {
            "object": "email",
            "label": "emain",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "birthDate",
            "label": "Дата рождения",
            "type": "DATE",
            "singleValue": false
        },
        {
            "object": "creationDate",
            "label": "Дата создания",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "firstName",
            "label": "Имя",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "howYouKnow",
            "label": "Как вы о нас узнали",
            "type": "DICTIONARY",
            "singleValue": true
        },
        {
            "object": "id",
            "label": "Номер лида",
            "type": "INTEGER",
            "singleValue": false
        },
        {
            "object": "passportNo",
            "label": "Номер паспорта",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "patronymic",
            "label": "Отчество",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "subdivision",
            "label": "Подразделение",
            "type": "DICTIONARY",
            "singleValue": true
        },
        {
            "object": "passportSeria",
            "label": "Серия",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "leadCustomStatus",
            "label": "Статус лида",
            "type": "DICTIONARY",
            "singleValue": true
        },
        {
            "object": "amount",
            "label": "Сумма",
            "type": "DOUBLE",
            "singleValue": false
        },
        {
            "object": "lastName",
            "label": "Фамилия",
            "type": "STRING",
            "singleValue": true
        }
    ]
}
                    
Описание параметров
Параметр Обязателен Тип данных Описание
object О [string]

Значение поля запрашиваемой сущности. Это значение нужно передавать в фильтрах в поле "field" в отчетах по заявкам.

label О [string]

Наименование поля запрашиваемой сущности. Значение самого поля указано в поле "object". 

type О [string]

Тип данных запрашиваемой сущности. Если значения этого поля "ENUM" или "DICTIONARY", то в методах использующих фильтры, нужно передавать идентификатор элемента справочника или энумератора ("ENUM"). В качестве примера можете посмотреть описание параметра "value1" метода "Отчет по заявкам" или "Активные займы". Параметр "value2" при этих значениях в таких методах не передатся. 

singleValue О [bool]

Это поле принимает значение true или false. Это поле определяет то, принимает ли сущность (object) одно значение или несколько.  Для лучшего понимания, смотрите примеры в методах "Получение полей сущности для ...", а также методы, использующие фильтры, смотрите описание параметров "value1", "value2" (например "Активные займы"). Если стоит значение false, то в методах, использующих фильтры нужно передавать значения и в параметре "value1" и "value2". Иначе передается только значение в параметре "value1".

Например:  

      {
            "object": "birthDate",
            "label": "Дата рождения",
            "type": "DATE",
            "singleValue": false
        } 

значение параметра  "singleValue": false, следовательно в методах использующих фильтры для фильтрации по полю birthDate передаем наример:

{
    "entity": "com.pq.establ.dict.Client",
    "field": "birthDate",
    "value1": "1890-01-01",
    "value2": "2000-11-28"
}