Метод «Создать документ»

Endpoint: POST {hostname}/dh-documents-service/api/v1/documents

Метод позволяет создать новый документ в Системе.

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

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

Входящие параметры Способ передачи параметров Требования к заполнению
pwc Query pwc=true – создание рабочей копии документа. pwc=false – создание опубликованного документа
verify Query Необходимость проверки на комплектность композитного документа перед созданием вложенного простого документа
name Body Наименование документа. Значение согласно описанию в зависимости от потребностей клиента
className Body Класс документа. Значение согласно описанию в зависимости от потребностей клиента
fileId Body Идентификатор файла (id), полученный методом GET {hostname}/dh-documents-service/api/v1/documents
compoundId Body UUID композитного документа, в который включен создаваемый простой документ. Только для простых документов, для композитных документов всегда null или не передается
someDynamicBoolAttribute Body Общий тип обязательных динамических атрибутов, определенных в модели класса документа, при их наличии

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

curl --location 'http://docshouse.k8s.lan.lanit.ru/dh-gateway-api-service/dh-documents-service/api/v1/documents' \
--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 '{
  "name": "Наименование простого документа",
  "className": "simple_document_class",
  "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "someDynamicBoolAttribute": true
}'