API Documentation - Получить поля сущностей для фильтрации в сложных залоговых процессах

17-02-2021 23:18

Получить поля сущностей для фильтрации в сложных залоговых процессах

GET /bs-core/main/processes/collaterals/filters/fields/{entityItem}

Получить поля сущности для фильтрации в сложных залоговых билетах.

Пошаговую инструкцию запуска сложного залогового процесса и использование этого метода в ней смотрите здесь.

Запрос

GET /main/processes/collaterals/filters/fields/com.pq.establ.dict.collateral.Collateral

Описание параметров

Параметр	Обязателен	Тип данных	Описание
entityItem	R	[string]	Сущность (смотрите значения сущности в описании параметра object в методе "Получить сущности для фильтрации в сложных залоговых процессах"). Параметр адресной строки.

Ответ


                        {
    "status": "ok",
    "timestamp": 1538557213274,
    "data": [
        {
            "object": "saleCode",
            "label": "Код залога для реализации",
            "type": "STRING",
            "singleValue": true
        },
        {
            "object": "storingPlace",
            "label": "Место хранения",
            "type": "DICTIONARY",
            "singleValue": true
        },
        {
            "object": "collateralType",
            "label": "Тип залога",
            "type": "DICTIONARY",
            "singleValue": true
        }
    ]
}

Описание параметров

Параметр	Обязателен	Тип данных	Описание
object	О	[string]	Наименование поля сущности, значение которого используется для значения в поле field в методе "Выборка залогов для запуска сложного залогового процесса" например (сущность com.pq.establ.dict.Contract): POST /bs-core/main/processes/collaterals/select/process-type-id/1014369/date/2018-09-01T00:00:00 [ { .... "field": "issueDate", .... или в методе "Запуск сложного залогового процесса" например (сущность com.pq.establ.dict.Contract): POST /bs-core/main/processes/collaterals/execute/process-type-id/1014369/date/2018-09-01T00:00:00 [ { .... "field": "issueDate", ....
label	О	[string]	Расшифровка поля object
type	О	[string]	Тип данных параметра. Значение этого параметра важно для того, чтобы знать какой тип данных передавать в параметрах value1, value2 в методах "Выборка залогов для запуска сложного залогового процесса" и "Запуск сложного залогового процесса". Для типа DICTIONARY в поле value1 передаем идентификатор элемента из этого справочника. Например запрос GET /bs-core/main/processes/collaterals/filters/fields/com.pq.establ.dict.Contract возвратил: .... { "object": "branch", "label": "Филиал", "type": "DICTIONARY", "singleValue": true } .... тогда в методах "Выборка залогов для запуска сложного залогового процесса" и "Запуск сложного залогового процесса" передаем .... { "entity":"com.pq.establ.dict.Contract", "field":"branch", "value1": 101301 } .... Для типа DATE в поле value1 и value2 передаем дату в формате "YYYY-MM-DD". Например запрос GET /bs-core/main/processes/collaterals/filters/fields/com.pq.establ.dict.Contract возвратил: .... { "object": "issueDate", "label": "Дата выдачи", "type": "DATE", "singleValue": false } .... тогда в методах "Выборка залогов для запуска сложного залогового процесса" и "Запуск сложного залогового процесса" передаем например: .... { "entity": "com.pq.establ.dict.Contract", "field": "issueDate", "value1": "2018-08-28", "value2": "2018-09-02" } ....
singleValue	О	[bool]	Одно значение да/нет. Этот параметр даёт понять предавать только поле value1 или ещё value2. Например запрос GET /bs-core/main/processes/collaterals/filters/fields/com.pq.establ.dict.Contract возвратил: .... { "object": "issueDate", "label": "Дата выдачи", "type": "DATE", "singleValue": false } .... тогда в методах "Выборка залогов для запуска сложного залогового процесса" и "Запуск сложного залогового процесса" передаем например: .... { "entity": "com.pq.establ.dict.Contract", "field": "issueDate", "value1": "2018-08-28", "value2": "2018-09-02" } ....