ShelfUploadPartInit
Загружает первый фрагмент документа на полку документов, генерирует для него имя и возвращает это имя в ответе.
Метод используется для загрузки файла большого объема по частям в связке с методом ShelfUploadPart. Размер одного фрагмента должен быть не больше 3 МБ, а размер всего загружаемого документа — до 400 MB.
Подробнее про загрузку документов на полку в разделе Загрузка документа на полку.
POST /ShelfUploadPartInit
Параметры запроса
fileExtension— расширение файла с точкой. Укажите, чтобы при скачивании файла его имя содержало расширение. Необязательный параметр.isLastPart— признак того, что загружается последний фрагмент документа. Для последнего фрагмента должен быть равенtrue, для остальных может отсутствовать или быть равнымfalse. По умолчанию имеет значениеfalse.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Тело запроса
Тело запроса должно содержать фрагмент документа. Максимальный размер одного фрагмента — 3 МБ.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.403— запрос сделан от заблокированного клиента API.405— используется неподходящий HTTP-метод.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит строку со сгенерированным именем файла, фрагмент которого загружен на полку.
Содержимое фрагмента нужно передать одним из способов:
- в виде бинарных данных — укажите заголовок
Content-Type: application/octet-stream; - в кодировке base64 — укажите заголовок
Content-Type: base64: сервер декодирует тело и сохраняет на полку полученные байты.
Примеры использования
Пример HTTP-запроса:
POST /ShelfUploadPartInit?fileExtension=.txt&isLastPart=false HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/octet-stream
Пример ответа:
dd-api-99048eaf-0635-4035-986a-add1c0089c3f
См. также
Методы для работы с полкой документов:
- ShelfDownload (V2) — загружает содержимое документа с полки документов
- ShelfUpload (V2) — загружает целиком содержимое документа на полку документов
- ShelfUploadPart — загружает фрагмент содержимого документа на полку документов, если первая его часть уже была загружена методом ShelfUploadPartInit
- ShelfUploadPartInit — загружает первый фрагмент документа на полку документов