Полка документов

Полка документов — временное хранилище данных в Диадоке. Она позволяет загружать содержимое документов небольшими частями, а затем передавать в методы API не само содержимое, а только имя документа на полке.

В качестве данных на полке документов может храниться содержимое документов, бинарное представление электронной подписи, архив с результатом выполнения метода GenerateDocumentZip и другие бинарные данные. Условно все эти данные в контексте полки будем называть документами.

Примечание

Полка является приоритетным способом передачи данных в методы API. Уже при размере содержимого документа от 500 KB рекомендуем использовать полку, а не передавать содержимое напрямую.

Некоторые методы API требуют передавать в них содержимое документов. Но содержимое может быть большим, что вызовет проблемы при его загрузке одной командой. Такая команда будет выполняться долго и даже может завершиться неуспехом. Для решения этой проблемы используется полка документов. Она позволяет загрузить содержимое документа в хранилище небольшими частями, а после передавать в методы API ссылку на документ на полке — имя документа. Таким образом, в методы можно передавать не содержимое документа, а только его имя на полке. Это ускоряет работу метода и повышает его надежность.

Ограничения

  • Нельзя загрузить на полку содержимое документа размером больше 400 MB.

  • Загруженный документ хранится на полке 7 дней, после чего автоматически удаляется.

См. также

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

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

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

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

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