POST api/v3/documents/{id}/attachments
Описание запроса
Запрос позволяет прикрепить файл к документу в Системе.
Входные параметры
В заголовке запроса укажите Id или Uuid или ExternalId документа, к которому нужно добавить файл.
|
Параметр |
Формат |
Обязательность |
Примечание |
|
Id |
Целое число |
Обязательно передать один из параметров |
Идентификатор документа, к которому нужно прикрепить файл |
|
Uuid |
string |
Универсальный уникальный идентификатор документа, к которому нужно прикрепить файл |
|
|
ExternalId |
string |
Идентификатор документа, к которому нужно прикрепить файл, во внешней системе |
В теле запроса укажите файл, который требуется прикрепить.
|
Параметр |
Формат |
Обязательность |
Примечание |
|
File |
string |
Обязательно |
Допустимые форматы файла: xls, xlsx, doc, docx, png, jpeg, jpg, zip or pdf. Максимальный размер: 20480 kB. Content Type: multipart/form-data |
В одном запросе можно отправить только один файл. Если к запросу прикрепить несколько файлов, только один из них будет добавлен в Систему. Если повторно отправить запрос с одним и тем же файлом, файл будет добавляться в Систему с индексом и новыми идентификаторами (Id и Uuid).
Пример запроса:
curl --location --request POST 'https://test.beta.doc.one/api/v3/documents/20309/attachments' \
--header 'Authorization: Basic ZzzzzzzzzZZZzzzZZzzzzZZZzzzzzZzzZZzzZZZZ=' \
--form 'File=@"/D:/Documents/Документ.pdf "'
Выходные параметры
В случае успешного запроса вернется описание добавленного файла.
|
Параметр |
Формат |
Примечание |
|
Id |
integer |
Идентификационный номер прикрепленного файла |
|
Uuid |
string |
Универсальный уникальный идентификатор прикреплённого файла |
|
Created |
datetime |
Дата и время добавления файла в формате "y-m-d h:i:s" |
|
FileName |
string |
Наименование файла |
|
Size |
string |
Размер файла |
|
Extension |
string |
Формат файла |
Пример ответа:
{
"Id": 128,
"Uuid": "d4c3a8be-905f-11eb-a385-02daccffe81b",
"Created": "2021-03-29T07:24:43+00:00",
"FileName": "ExampleAttached",
"Size": 368181,
"Extension": "pdf"
}
Комментарии
0 комментариев
Войдите в службу, чтобы оставить комментарий.