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

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

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

Более подробное описание метода находится в 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
documentsList: · documentId · versionId · rollbackVersionDocument · deleteSourceDocument	Body	Список версий документов: · Идентификатор документа (id), полученный методом GET {hostname}/dh-documents-service/api/v1/documents; · Идентификатор версии документа (id), полученный методом GET {hostname}/dh-documents-service/api/v1/documents/{id}/versions. · Включение предыдущей (наибольшей по номеру) неудаленной версии в версию КД. · Удаление версии всех исключаемых документов
rollbackVersionDocument	Body	Произвести попытку включения предыдущей (наибольшей по номеру) неудаленной версии в версию композитного документа
deleteSourceDocument	Body	Произвести попытку удаления версий все исключаемых документов

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

curl --location 'https://docshouse-dev.k8s.lan.lanit.ru/dh-documents-service/api/v1/documents/3fa85f64-5717-4562-b3fc-2c963f66afa6/versions/3fa85f64-5717-4562-b3fc-2c963f66afa6/exclude' \
--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 '{
  "documentsList": [
    {
      "documentId": "41e14972-ada9-435a-8955-1c29b3d41295",
      "versionId": "41e14972-ada9-435a-8955-1c29b3d41295",
      "rollbackVersionDocument": false,
      "deleteSourceDocument": false
    }
  ],
  "rollbackVersionDocuments": true,
  "deleteSourceDocuments": true
}'