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

Endpoint: POST {hostname}/dh-documents-service/api/v1/documents/{id}/versions/{versionId}/renditions/content

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

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

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

Входящие параметры Способ передачи параметров Требования к заполнению
X-Correlation-ID Header Опциональный ключ корреляции для операции
id Path Идентификатор документа (id), полученный методом GET {hostname}/dh-documents-service/api/v1/documents
versionId Path Идентификатор версии документа (id), полученный методом GET {hostname}/dh-documents-service/api/v1/documents/{id}/versions
sourceObjectUri Body URI объекта или версии объекта, к которому относится альтернативное представление
name Body Наименование альтернативного представления
kind Body Вид альтернативного представления. Доступные значения: STREAM, ALTERNATIVE, THUMBNAIL, PRINT_READY, TRANSLATED
label Body Текстовая метка альтернативного представления
fileUploadProperties:
· fileName
· hashCode
· retentionDate
· mimeType
· fileSize
· policyCode
· additionalProp1		 Body Дополнительные атрибуты файла для загрузки

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

curl --location 'https://docshouse-dev.k8s.lan.lanit.ru/dh-documents-service/api/v1/documents/b93efcf5-1fd6-4481-a0d4-2c43b6cb080c/versions/0f58040b-25e9-4775-acba-14a0b34e50e4/renditions/content' \
  -header 'accept: */*' \
  -header 'X-Correlation-ID: 20279fe4-079e-4b70-87fd-73a65e011624' \
  -header 'Content-Type: application/json' \
  -data '{
  "sourceObjectUri": "string",
  "name": "test",
  "kind": "ALTERNATIVE",
  "label": "string",
  "fileUploadProperties": {
    "fileName": "string",
    "hashCode": "1f52358b47a885069aca26d7e8c0ce9b348be8a683c5c8fa0ae8f271fa8b8d42",
    "retentionDate": "2007-12-03T10:15:30Z",
    "mimeType": "string",
    "fileSize": "1024",
    "policyCode": "string",
    "additionalProp1": {}
  }
}'