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

GetTemplate

warning

Метод устарел и будет удален из API после 30 ноября 2026 года. Подробнее в истории изменений. Для получения шаблона используйте метод GetMessage (V6).

Получает шаблон документов.

GET /GetTemplate

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

  • boxId — идентификатор ящика организации в формате GUID.
  • templateId — идентификатор сообщения-шаблона.
  • entityId — идентификатор документа в сообщении. Необязательный параметр; если указан, то возвращаются только сущности, связанные с данным документом.

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

Коды ответа

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

Выдаваемая структура Template включает в себя сущности из всех дополнений, составляющих цепочку документооборота templateId.

Вся информация, относящаяся к данной цепочке (в частности, документы и подписи), по возможности помещается в протобуфер. Суммарный размер бинарных представлений (структура Content, поле Data) не может превышать 1 048 576 байт. Если добавление очередного бинарного представления вызовет превышение этого ограничения, то это бинарное представление не будет добавлено в протобуфер.

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

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

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