GetEntityContent (V4)

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

GET /V4/GetEntityContent

Query Parameters:

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

Request Headers:

Authorization – данные, необходимые для авторизации.

Status Codes:

200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
404 Not Found – не найдены документ или сообщение с указанным идентификатором или у указанной сущности нет содержимого.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит бинарное представление сущности с идентификатором 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}}
Content-Type: application/json charset=utf-8
Accept: application/json

См. также

Инструкции:

Работа с документами

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

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