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

GetEntityContent (V4)

Возвращает содержимое указанной сущности.

GET /V4/GetEntityContent

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

  • boxId — идентификатор ящика организации в формате GUID.
  • messageId — идентификатор сообщения.
  • entityId — идентификатор сущности в сообщении.

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

Коды ответа

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

Тело ответа

Тело ответа содержит бинарное представление сущности с идентификатором entityId из сообщения с идентификатором messageId в ящике boxId. Если у указанной сущности нет содержимого, метод вернет ошибку 404 (Not Found).

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

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

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

GET /V4/GetEntityContent?boxId={{boxId}}&messageId={{messageId}}&entityId={{entityId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}

См. также

Инструкции:

Методы для работы с сущностью:

  • GetEntityContent (V4) — возвращает содержимое указанной сущности

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

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

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