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

GetDocumentHistory

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

GET /GetDocumentHistory

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

  • boxId — идентификатор ящика организации в формате GUID.
  • messageId — идентификатор сообщения.
  • entityId — идентификатор сущности в сообщении.
  • embed — связанные данные, которые нужно включить в ответ. Можно указать несколько значений через запятую. Необязательный параметр. Принимает значения: - Comments — содержимое комментариев к событиям, - ResolutionEntities — содержимое сущностей, относящихся к согласованию документа или запроса на аннулирование.

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

Коды ответа

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

Тело ответа

Тело ответа содержит историю событий, представленную структурой DocumentHistory.

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

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

GET /GetDocumentHistory?boxId={{boxId}}&messageId={{messageId}}&entityId={{entityId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json

Пример тела ответа:

{
"Items": [
{
"OccurredAt": {
"Ticks": 638562073531053865
},
"Category": "Outgoing",
"Type": "Sent",
"BoxId": "{{boxId}}",
"Author": {
"UserId": "{{userId}}",
"DisplayName": "Иванов Иван",
"Gender": "Male",
"Position": "Менеджер"
},
"DepartmentId": "00000000-0000-0000-0000-000000000000",
"Payload": {
"Sent": {}
}
},
{
"OccurredAt": {
"Ticks": 638562073540225572
},
"Category": "Incoming",
"Type": "Received",
"BoxId": "{{boxId}}",
"Payload": {
"Received": {
"Recipients": [
{
"BoxId": "{{boxId}}",
"Role": "recipient",
"Flags": {
"IsRoaming": false,
"IsCrossborder": false,
"IsForeign": false
},
"Type": "Recipient",
"IsCurrentBox": true
}
],
"TitleIndex": 0,
"TitleEntityId": "{{entityId}}"
}
}
}
],
"ReferenceData": {
"Boxes": [
{
"BoxId": "{{boxId}}",
"BoxTitle": "Основной ящик",
"OrganizationId": "{{organizationId}}",
"OrganizationInn": "6663003127",
"OrganizationKpp": "667301001",
"OrganizationFullName": "ООО «Ромашка»",
"OrganizationShortName": "Ромашка"
}
],
"Departments": []
}
}

См. также

Методы для работы с документами:

  • Delete — отмечает указанный документ как удаленный
  • GetContent — возвращает XSD-схему документа
  • GetDocument (V3) — возвращает данные документа по указанному идентификатору
  • GetDocumentActions — возвращает список действий, доступных текущему пользователю для указанного документа, шаблона или черновика
  • GetDocumentHistory — возвращает историю событий по указанному документу, шаблону или черновику
  • GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам
  • GetDocuments (V4) — возвращает список документов, соответствующих заданным параметрам
  • GetDocumentsByMessageId — возвращает список документов из указанного сообщения
  • GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике
  • GetDocumentTypes (V3) — возвращает список типов документов, доступных в ящике, и дату перехода на универсальные сообщения
  • MoveDocuments — перемещает документы в указанное подразделение организации
  • Restore — восстанавливает документ из удаленных

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

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

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