GetDocument (V3)

Возвращает данные документа по указанному идентификатору.

GET /V3/GetDocument
Query Parameters:

  • boxId – идентификатор ящика организации.

  • messageId – идентификатор сообщения.

  • entityId – идентификатор сущности типа LetterAttachment в сообщении.

  • injectEntityContent – признак того, что в результат нужно включить содержимое документа. Если указано значение true, то содержимое документа будет добавлено в поле ответа Content.Data. Необязательный параметр, по умолчанию равен true. Обратите внимание, что добавление содержимого замедляет работу метода.

Request Headers:
Status Codes:

  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у указанного ящика закончилась подписка на API.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.

  • 404 Not Found – в указанном ящике не найдено сообщение с идентификатором messageId или в указанном сообщении нет сущности типа LetterAttachment с идентификатором entityId.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит информацию о документе entityId из сообщения messageId в ящике boxId, представленную структурой Document.

Содержимое документа хранится в поле Document.Content. Формат содержимого зависит от типа документа. Все форматы содержимого описаны на странице Entity.

Размер содержимого в поле Content.Data не должен превышать 1048576 байт. Если размер содержимого документа превышает это значение, то оно не будет включено в ответ независимо от значения параметра injectEntityContent. В этом случае получить содержимое документа можно с помощью метода GetEntityContent (V4).

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

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

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

GET /V3/GetDocument?boxId={{boxId}}&messageId={{messageId}}&entityId={{entityId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8
Content-Type: application/json

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

{
    "MessageId": "b7a4809e-ff8f-4a6c-86ae-0f514c353afd",
    "EntityId": "132c02e7-2d07-43f2-bf23-c9bc52f281e9",
    "CreationTimestampTicks": 638772119340795259,
    "CounteragentBoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru",
    "DocumentType": "UnknownDocumentType",
    "InitialDocumentIds": [],
    "SubordinateDocumentIds": [],
    "Content": {
        "Size": 6658,
        "Data": "PD94bWwgdm...Pg0KPC/U4OnrPg=="
    },
    "FileName": "DP_PRIRASXPRINMARK_2BM-4934609619-757645784-202407101104400484330_2BM-0299242701-732644841-202407101103418496883_20230116_17b84e47-f0c7-454e-a491-289dc2ace6c3.xml",
    "DocumentDate": "16.01.2023",
    "DocumentNumber": "1",
    "IsDeleted": false,
    "DepartmentId": "00000000-0000-0000-0000-000000000000",
    "IsTest": false,
    "FromDepartmentId": "00000000-0000-0000-0000-000000000000",
    "ToDepartmentId": "00000000-0000-0000-0000-000000000000",
    "RevocationStatus": "RevocationStatusNone",
    "SendTimestampTicks": 638772119340795259,
    "DeliveryTimestampTicks": 638772119344269072,
    "ForwardDocumentEvents": [],
    "RoamingNotificationStatus": "RoamingNotificationStatusNone",
    "HasCustomPrintForm": false,
    "CustomData": [],
    "DocumentDirection": "Inbound",
    "LastModificationTimestampTicks": 638772135535969010,
    "IsEncryptedContent": false,
    "SenderSignatureStatus": "SenderSignatureCheckedAndValid",
    "IsRead": true,
    "PacketIsLocked": false,
    "ProxySignatureStatus": "ProxySignatureStatusNone",
    "TypeNamedId": "Torg2",
    "Function": "NoAdditionalInfo",
    "WorkflowId": 1,
    "Title": "Акт ТОРГ-2 №1 от 16.01.23",
    "Metadata": [
        {
            "Key": "FileName",
            "Value": "DP_PRIRASXPRINMARK_2BM-4934609619-757645784-202407101104400484330_2BM-0299242701-732644841-202407101103418496883_20230116_17b84e47-f0c7-454e-a491-289dc2ace6c3.xml"
        },
        {
            "Key": "DocumentNumber",
            "Value": "1"
        },
        {
            "Key": "DocumentDate",
            "Value": "16.01.2023"
        }
    ],
    "RecipientReceiptMetadata": {
        "ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
        "ConfirmationMetadata": {
            "ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
            "DateTimeTicks": 0
        }
    },
    "ConfirmationMetadata": {
        "ReceiptStatus": "GeneralReceiptStatusNotAcceptable",
        "DateTimeTicks": 638772119344269072
    },
    "RecipientResponseStatus": "RecipientResponseStatusNotAcceptable",
    "AmendmentRequestMetadata": {
        "AmendmentFlags": 0,
        "ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
    },
    "EditingSettingId": "",
    "LockMode": "None",
    "SenderReceiptMetadata": {
        "ReceiptStatus": "GeneralReceiptStatusNotAcceptable"
    },
    "Version": "torg2_05_01_01",
    "LastOuterDocflows": [],
    "DocflowStatus": {
        "PrimaryStatus": {
            "Severity": "Info",
            "StatusText": "Документооборот завершен"
        },
        "PowerOfAttorneyGeneralStatus": {
            "Severity": "Warning",
            "StatusNamedId": "IsNotAttached",
            "StatusText": "Не приложена доверенность",
            "Errors": []
        }
    },
    "TtGisFixationCancellationStatus": "TtGisFixationCancellationStatusNone",
    "MessageIdGuid": "b7a4809e-ff8f-4a6c-86ae-0f514c353afd",
    "EntityIdGuid": "132c02e7-2d07-43f2-bf23-c9bc52f281e9",
    "CreationTimestamp": "2025-03-10T13:58:54.0795259Z"
}

См. также

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

  • Delete — отмечает указанный документ как удаленный

  • GetContent — возвращает XSD-схему документа

  • GetDocument (V3) — возвращает данные документа по указанному идентификатору

  • GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам

  • GetDocumentsByMessageId — возвращает список документов из указанного сообщения

  • GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике

  • MoveDocuments — перемещает документы в указанное подразделение организации

  • Restore — восстанавливает документ из удаленных