Метод «Получить список альтернативных представлений документ໶
Endpoint: GET {hostname}/dh-documents-service/api/v1/documents/{id}/versions/{versionId}/renditions
Метод позволяет получить полный список альтернативных представлений по идентификатору документа.
Более подробное описание метода находится в yaml файле «documents_service», который расположен в папке с документацией.
Маппинг параметров запроса
| Входящие параметры | Способ передачи параметров | Требования к заполнению |
|---|---|---|
| id | Path | Идентификатор документа (id), полученный методом GET {hostname}/dh-documents-service/api/v1/documents |
| versionId | Path | Идентификатор версии документа (id), полученный методом GET {hostname}/dh-documents-service/api/v1/documents/{id}/versions |
| kind | Query | Вид альтернативного представления. Доступные значения: STREAM, ALTERNATIVE, THUMBNAIL, PRINT_READY, TRANSLATED |
| label | Query | Текстовая метка альтернативного представления |
| mimeType | Query | Тип файла альтернативного представления |
| fields | Query | Список атрибутов, разделенных запятой |
| page | Query | Номер страницы, нумерация начинается с 0. Значение согласно описанию в зависимости от потребностей клиента |
| size | Query | Количество возвращаемых записей для одной страницы. Значение согласно описанию в зависимости от потребностей клиента |
| sort | Query | Параметр сортировки. Значение согласно описанию в зависимости от потребностей клиента |
Пример запроса:
curl --location 'https://docshouse-dev.k8s.lan.lanit.ru/dh-documents-service/api/v1/documents/e65c7375-9586-4ee5-b65e-7c480d60b9c2/versions/08cd9656-4a49-47bf-b168-fe16b2633035/renditions?label=ru&kind=ALTERNATIVE&mimeType=string&fields=id&page=1&size=2&sort=creationDate%2CASC' \
-header 'accept: */*'