GET api/v3/documents/{id}/attachments
Описание запроса
Запрос позволяет получить список файлов документа.
Входные параметры
В заголовке запроса нужно указать Id или Uuid или ExternalId документа, к которому добавлены файлы.
Параметр |
Формат |
Обязательность |
Примечание |
Id |
integer |
Обязательно передать один из параметров |
Идентификатор документа, к которому добавлены файлы, в Системе |
Uuid |
string |
Универсальный уникальный идентификатор документа, к которому добавлены файлы |
|
ExternalId |
string |
Идентификатор документа, к которому добавлены файлы, во внешней системе |
Пример запроса:
curl --location --request GET 'https://local.doc.one/api/v3/documents/20309/attachments' \
--header 'Authorization: Basic ZzzzzzzzzZZZzzzZZzzzzZZZzzzzzZzzZZzzZZZZ='
Выходные параметры
В случае успешного запроса вернется список файлов документа с параметрами каждого файла.
Параметр |
Формат |
Примечание |
Id |
integer |
Идентификационный номер прикрепленного файла |
Uuid |
string |
Универсальный уникальный идентификатор прикреплённого файла |
Created |
datetime |
Дата и время добавления файла в формате "y-m-d h:i:s" |
FileName |
string |
Наименование файла |
Size |
string |
Размер файла |
Extension |
string |
Формат файла |
Пример ответа:
[
{
"Id": 118,
"Uuid": "5b6abe6a-8643-11eb-abaf-02daccdfd853",
"Created": "2021-03-16T10:35:41+00:00",
"FileName": "Document-1",
"Size": 69817,
"Extension": "txt"
},
{
"Id": 117,
"Uuid": "58537492-8643-11eb-a043-02daccdfd853",
"Created": "2021-03-16T10:35:36+00:00",
"FileName": "Document-2",
"Size": 48932,
"Extension": "docx"
}
]
Комментарии
0 комментариев
Войдите в службу, чтобы оставить комментарий.