Метод «Получить список документов (текущие версии или рабочие копии)»¶

Endpoint: GET {hostname}/dh-documents-service/api/v1/documents

Метод позволяет получить список документов, их текущих версий или рабочих копий, с учетом постраничного разбиения и сортировки.

Более подробное описание метода находится в yaml файле «documents_service», который расположен в папке с документацией.

Маппинг параметров запроса

Входящие параметры	Способ передачи параметров	Требования к заполнению
mode	Query	Состояние версии документа. Enum – CURRENT – только текущие версии документов, PWC – только рабочие копии документов. По умолчанию – CURRENT
className	Query	Класс документа. Значение согласно описанию в зависимости от потребностей клиента
page	Query	Номер страницы, нумерация начинается с 0. Значение согласно описанию в зависимости от потребностей клиента
size	Query	Количество возвращаемых записей для одной страницы. Значение согласно описанию в зависимости от потребностей клиента
sort	Query	Параметр сортировки. Значение согласно описанию в зависимости от потребностей клиента
offset	Query	Количество просмотренных записей за предыдущие итерации. Значение согласно описанию в зависимости от потребностей клиента

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

curl --location 'https://docshouse.ldm.lanit.ru/dh-gateway-api-service/dh-documents-service/api/v1/documents?mode=CURRENT&className=auto_postman_test&page=0&size=100&sort=creationDate%2Cdesc&offset=0' \

--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