Метод «Получить список бизнес-объектов по заданным в запросе параметра컶
Endpoint: GET {hostname}/dh-documents-service/api/v1/items
Метод позволяет получить список бизнес-объектов с учетом постраничного разбиения и сортировки.
Более подробное описание метода находится в yaml файле «documents_service», который расположен в папке с документацией.
Маппинг параметров запроса
| Входящие параметры | Способ передачи параметров | Требования к заполнению |
|---|---|---|
| className | Query | Класс объекта. Значение согласно описанию в зависимости от потребностей клиента |
| page | Query | Номер страницы, нумерация начинается с 0. Значение согласно описанию в зависимости от потребностей клиента |
| size | Query | Количество возвращаемых записей для одной страницы. Значение согласно описанию в зависимости от потребностей клиента |
| sort | Query | Параметр сортировки. Значение согласно описанию в зависимости от потребностей клиента |
| offset | Query | Количество просмотренных записей за предыдущие итерации. Значение согласно описанию в зависимости от потребностей клиента |
| excludePropertyTypes | Query | Список типов параметров для исключения из ответа |
Пример запроса:
curl --location 'http://docshouse-dev.k8s.lan.lanit.ru/dh-gateway-api-service/dh-documents-service/api/v1/items/?page=1&size=20&sort=creationDate%2Cdesc&className=item_test' \
--header 'accept: */*' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/101.0.4951.64 Safari/537.36' \
--header 'Authorization: Bearer