Перейти к основному содержимому

ShelfUploadPart

Загружает фрагмент содержимого документа на полку документов, если первая его часть уже была загружена методом ShelfUploadPartInit.

Размер одного фрагмента должен быть не больше 3 МБ, а размер всего загружаемого документа — до 400 MB.

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

POST /ShelfUploadPart

Параметры запроса

  • fileName — имя документа на полке документов, сгенерированное методом ShelfUploadPartInit. Обязательный параметр.
  • partIndex — номер загружаемого фрагмента документа. Фрагменты индексируются с 0, при этом нулевой фрагмент был загружен методом ShelfUploadPartInit: поэтому при первом вызове метода ShelfUploadPart передайте параметр partIndex = 1, а при каждом следующем вызове увеличивайте на 1.
  • isLastPart — признак того, что загружается последний фрагмент документа. Для последнего фрагмента должен быть равен true, для остальных может отсутствовать или быть равным false. По умолчанию имеет значение false.

Заголовки запроса

Тело запроса

Тело запроса должно содержать фрагмент документа. Максимальный размер одного фрагмента — 3 МБ.

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 403 — запрос сделан от заблокированного клиента API.
  • 405 — используется неподходящий HTTP-метод.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

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

Содержимое фрагмента нужно передать одним из способов:

  • в виде бинарных данных — укажите заголовок Content-Type: application/octet-stream;
  • в кодировке base64 — укажите заголовок Content-Type: base64: сервер декодирует тело и сохраняет на полку полученные байты.

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

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

POST /ShelfUploadPart?fileName=dd-api-99048eaf-0635-4035-986a-add1c0089c3f&partIndex=1&isLastPart=true HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/octet-stream

См. также

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

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

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года