ShelfUpload (V2)

Загружает содержимое документа на полку документов целиком, генерирует для него имя и возвращает это имя в ответе.

Максимальный размер документа, который можно загрузить этим методом, — 512 KB. Для документов большего размера используйте методы ShelfUploadPartInit и ShelfUploadPart, чтобы загрузить документ по частям.

Подробнее про загрузку документов на полку в разделе Работа с полкой документов.

POST /V2/ShelfUpload

Query Parameters:

fileExtension – расширение файла с точкой. Укажите, чтобы при скачивании файла его имя содержало расширение. Необязательный параметр.

Request Headers:

Authorization – данные, необходимые для авторизации.

Request Body:

Тело запроса должно содержать бинарные данные, представляющие собой содержимое документа. Максимальный размер документа — 512 KB.

Status Codes:

200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит строку со сгенерированным именем файла, загруженного на полку.

Если документ успешно загружен, то он становится доступным для чтения с полки документов:

его имя можно указать в поле NameOfShelf структур SignedContent и UnsignedContent,

документ можно скачать с полки методом ShelfDownload (V2).

Примеры использования

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

POST /V2/ShelfUpload?fileExtension=.txt HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: text/plain; charset=utf-8

Пример ответа:

dd-api-6831e2e9-cc81-48d5-807d-fe51c2037d44

См. также

Методы для работы с полкой документов:

ShelfDownload (V2) — загружает содержимое документа с полки документов
ShelfUpload (V2) — загружает содержимое документа на полку документов целиком
ShelfUploadPart — загружает фрагмент содержимого документа на полку документов, если первая его часть уже была загружена методом ShelfUploadPartInit
ShelfUploadPartInit — загружает первый фрагмент документа на полку документов

Устаревшие версии метода:

ShelfUpload