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

ShelfUpload

warning

Метод устарел и будет удален из API после 30 сентября 2026 года. Подробнее в истории изменений. Используйте актуальную версию метода: ShelfUpload (V2).

к сведению

При попытке загрузить файл в публичное пространство имен метод вернет ошибку 400 (Bad Request).

Метод ShelfUpload загружает фрагмент содержимого документа на полку документов.

POST /ShelfUpload

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

  • nameOnShelf — имя документа на полке документов.
  • partIndex — номер загружаемого фрагмента документа. Фрагменты индексируются с 0.
  • isLastPart — признак того, что загружается последний фрагмент документа. Для последнего фрагмента должен быть равен 1, для остальных может отсутствовать или быть равным 0.

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

Тело запроса

Тело запроса должно содержать фрагмент содержимого.

Коды ответа

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

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

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

Для выполнения метода текущий пользователь должен быть авторизован в Диадоке, иначе метод вернет ошибку 403 (Forbidden).

При загрузке документа укажите в параметре nameOnShelf его будущее имя на полке. Вы можете загрузить документ в локальное пространство имен полки.

Чтобы загрузить документ на полку, разделите его бинарное содержимое на части и загрузите каждую часть отдельным вызовом метода ShelfUpload.

к сведению

Размер каждой загружаемой части содержимого не должен превышать 70 Мб.

Последнюю часть документа загрузите с параметром isLastPart = 1: это сообщит серверу, что вы загрузили все части документа. В ответе метод сообщит, все ли части были загружены успешно.

Если при загрузке каких-то частей документа произошли ошибки, то метод вернет в теле ответа список номеров этих частей в формате JSON. Загрузите эти части повторно.

Если документ загружен полностью, то он становится доступным для чтения с полки документов, и его имя можно указать в поле NameOfShelf структур SignedContent и UnsignedContent.

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

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

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