Метод «Создать новый пакет архивации»¶
Endpoint: POST {hostname}/ldm-packager-objects-service/api/v1/packages
Метод позволяет создать новый пакет архивации и задать основные свойства формирования архива.
Более подробное описание метода находится в yaml файле «packager-objects_service», который расположен в папке с документацией.
Маппинг параметров запроса
| Входящие параметры | Способ передачи параметров | Требования к заполнению |
|---|---|---|
| archiveName | Body | Имя файла ZIP результирующего архива. Если не задан, наименование файла формируется автоматически |
| options: · archiveStructure · reportType · uploadFiles · uploadSignatures · storageDuration · format |
Body | · Формат формирования структуры архива. «TREE» – древовидная структура архива. «PLAIN» – плоская структура архива. · Формат отчета включенных в архив документов, файлов, ЭП: - «NONE» – отчет не формируется; - «CSV» – формируются файлы отчета (манифесты) в формате csv: events.csv, objects.csv, documents_manifest.csv, files_manifest.csv, signatures_manifest.csv; - «DOCX» – формируется файл отчета в формате docx; - «XLSX» – формируется файл отчета в формате xlsx; - «PDF» – формируется файл отчета в формате pdf (структура отчета - docx). · Признак необходимости добавления в архив файлов документов. · Признак необходимости добавления ЭП, прикрепленных к файлам. · Количество минут, в зависимости от которого рассчитывается дата и время, когда сформированный файл архива необходимо удалить из Системы. · Формат формируемого архива |
Пример запроса:
curl --location 'https://docshouse-dev.k8s.lan.lanit.ru/ldm-packager-objects-service/api/v1/packages' \
--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 'Content-Type: application/json' \
--header 'Authorization: Bearer
--data '{
"archiveName": "package_01.01.24",
"options": {
"archiveStructure": "TREE",
"reportType": "CSV",
"uploadFiles": true,
"uploadSignatures": false,
"storageDuration": 1440,
"format": "ZIP"
}
}'