ShelfUploadPartInit

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

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

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

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

  • isLastPart – признак того, что загружается последний фрагмент документа. Для последнего фрагмента должен быть равен true, для остальных может отсутствовать или быть равным false. По умолчанию имеет значение false.

Request Headers:
Request Body:

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

Status Codes:
  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

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

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

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

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

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

dd-api-99048eaf-0635-4035-986a-add1c0089c3f

См. также

Методы для работы с полкой документов:
  • ShelfDownload (V2) — загружает содержимое документа с полки документов

  • ShelfUpload (V2) — загружает содержимое документа на полку документов целиком

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

  • ShelfUploadPartInit — загружает первый фрагмент документа на полку документов