Метод «Добавить документы в пакет архивации»

Endpoint: POST {hostname}/ldm-packager-objects-service/api/v1/packages/{packageId}/entries/documents

Метод позволяет добавить документы, их версии и вложенные в КД документы в пакет архивации.

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

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

Входящие параметры Способ передачи параметров Требования к заполнению
packageId Path Идентификатор пакета архивации (id), полученный методом GET {hostname}/ldm-packager-objects-service/api/v1/packages
options:
· documentNameMask
·fileNameMask
· signatureNameMask		 Body Настройки включения документов в архив:
· Наименование документа. Влияет на наименование папки версии документа при иерархической структуре архива.
· Наименование файла, прикрепленного к документу, под которым файл будет размещен в архиве. Наименование файла указывается без расширения, расширение наследуется от самого файла.
· Наименование файла ЭЦП, прикрепленного к файлу документа, под которым файл ЭЦП будет размещен в архиве. Наименование файла указывается без расширения, расширение наследуется от самого файла ЭЦП
access Body Список действий, которые разрешены с объектом на момент добавления объекта в архив пользователю, добавившему этот объект в архив, которые влияют на результат формирования архива
document:
· id
· versionId
· versionNumber
· name
· className
· fileId
· isCompound
· compoundId		 Body Документы, включаемые в архив: наименование, класс, идентификатор файла, связанного с документом, идентификатор композитного документа, в версию которого вложена версия этого документа. (обязателен только для композитного документа)
nestedDocuments:
· options:
- documentNameMask
- fileNameMask
- signatureNameMask
· access:
· document:
- id
- versionId
- versionNumber
- name
- className
- fileId
- isCompund
- compoundId
- additionalProp1
- additionalProp2
- additionalProp3
· additionalProp1
· additionalProp2
· additionalProp3		 Body Вложения в композитный документ

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

curl --location 'https://docshouse-dev.k8s.lan.lanit.ru/ldm-packager-objects-service/api/v1/packages/e161be77-5cd6-4275-a45f-98912f0c71f0/entries/documents' \
  -header 'accept: application/json' \
  -header 'Content-Type: application/json' \
  -data '[
  {
    "options": {
      "documentNameMask": "testDocMask",
      "fileNameMask": "testFileMask",
      "signatureNameMask": "testSignMask"
    },
    "access": [
      "read"
    ],
    "document": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "versionNumber": 0,
      "name": "string",
      "className": "string",
      "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isCompound": true,
      "compoundId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "nestedDocuments": [
      {
        "options": {
          "documentNameMask": "testDocMask2",
          "fileNameMask": "testFileMask2",
          "signatureNameMask": "testSignMask2"
        },
        "access": [
          "read"
        ],
        "document": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "versionNumber": 0,
          "name": "string",
          "className": "string",
          "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "isCompound": true,
          "compoundId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    ]
  }
]'