Управление документами внутри ящика

На этой странице описаны возможности управления документами в своем ящике.

Доступные действия с документом

Прежде, чем производить с документом какие-либо действия, пользователь может узнать, доступно ли ему это действие в данный момент. Таким образом можно избежать ошибок при вызове методов API.

Для получения списка доступных действий используйте метод GetDocumentActions. Метод работает не только с документами, но и с шаблонами и черновиками.

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

GET /GetDocumentActions?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

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

{
    "Actions": [
        {
            "Type": "AttachParticipantTitle",
            "Payload": {
                "AttachParticipantTitle": {
                    "TitleIndex": 1,
                    "IsOptional": false
                }
            }
        },
        {
            "Type": "ConfirmReceiptOfTitle",
            "Payload": {
                "ConfirmReceiptOfTitle": {
                    "TitleIndex": 0
                }
            }
        },
        {
            "Type": "Delete"
        },
        {
            "Type": "Move"
        }
    ]
}

Перемещение документов между подразделениями

Чтобы переместить документы из одного подразделения в другое, используйте метод MoveDocuments. В рамках одного запроса можно переместить в 1 подразделение до 1000 документов.

В теле запроса передайте информацию для перемещения документов между подразделениями в виде структуры DocumentsMoveOperation.

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

POST /MoveDocuments HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}

Пример тела запроса метода MoveDocuments:

{
    "BoxId": "09ae254c-5cd0-4082-84de-7ccb46d86f82",
    "ToDepartmentId": "022882f3-f29e-4611-8fa5-93385df7ac0f",
    "DocumentIds": [
        {
            "MessageId": "a73ca2e3-3d5c-4207-886c-9b854c179e15",
            "EntityId": "d084afd4-ec41-4fb6-9b5b-cf3e3ac5bef7"
        },
        {
            "MessageId": "a23dac5c-9c6a-4b20-91ed-69b3a7ce6158",
            "EntityId": "1ada67c0-aa8b-4f31-af8e-53660275f1b3"
        },
        {
            "MessageId": "d94982e8-7eb9-4993-8c52-41c14e3fc3a8 ",
            "EntityId": "05ea290d-9aa1-4291-a87b-d30be9ccf5b7"
        }
    ]
}

Удаление документов

Чтобы отметить документ как удаленный, используйте метод Delete.

Обратите внимание, что документы нельзя полностью уничтожить из Диадока. Метод Delete позволяет лишь пометить документ удаленным в рамках указанного ящика. Такая пометка не влияет на юридическую силу документа и не передается остальным сторонам документооборота. Удаленный документ всегда можно восстановить с помощью метода Restore.

В параметрах запроса передайте идентификаторы boxId и messageId сообщения, чтобы удалить все содержащиеся в нем документы. Для удалеления только одного документа из сообщения, дополнительно укажите его documentId в параметрах запроса.

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

POST /Delete?boxId={{boxid}}&messageid={{messageid}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}

Восстановление удаленных документов

Восстановить документ из удаленных можно с помощью метода Restore. Метод снимает с указанного документа пометку об удаленности.

В параметрах запроса передайте идентификаторы boxId и messageId сообщения, чтобы восстановить все содержащиеся в нем документы. Для восстановления только одного документа из сообщения, дополнительно укажите его documentId в параметрах запроса.

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

POST /Restore?boxId={{boxid}}?messageid={{messageid}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}