Метод «Включить версию простого документа в состав версии композитного документа»

Endpoint: POST {hostname}/dh-documents-service/api/v1/documents/{Id}/versions/{versionId}/include

Метод позволяет включить существующую версию документа в состав композитного документа в качестве простого документа с идентификатором (id).

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

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

Входящие параметры Способ передачи параметров Требования к заполнению
verify Query Необходимость проверки на комплектность композитного документа перед включением версии документа в версию композитного
id Path Идентификатор объекта (id), полученный методом GET {hostname}/dh-documents-service/api/v1/documents
versionId Path Идентификатор версии объекта (id), полученный методом GGET {hostname}/dh-documents-service/api/v1/documents/{id}/versions
verify Query Необходимость проверки на комплектность композитного документа перед включением версии документа в версию композитного
documentsList:
· documentId
· versionId
· orderRelation
Body Идентификатор документа (id), полученный методом GET {hostname}/dh-documents-service/api/v1/documents Идентификатор версии документа (id), полученный методом GET {hostname}/dh-documents-service/api/v1/documents/{id}/versions. Порядок для включенного документа

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

curl --location 'https://docshouse-dev.k8s.lan.lanit.ru/dh-documents-service/api/v1/documents/16749214-3cv4-12b1-25fc-4146e32218b/versions/16749214-3cv4-12b1-25fc-4146e32218b/include' \
  -header 'accept: application/json' \
  -header 'Content-Type: application/json' \
  -data '{
  "documentsList": [
      "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "orderRelation": true
    },
    {
      "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}'