GetWorkflowsSettings (V2)

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

GET /V2/GetWorkflowsSettings

Query Parameters:

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

Request Headers:

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

Status Codes:

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

Response Body:

Тело ответа содержит список элементов со свойствами вида документооборота, представленный структурой DocumentWorkflowSettingsListV2:

message DocumentWorkflowSettingsListV2 {
    repeated DocumentWorkflowSettingsV2 DocumentWorkflowSettings = 1;
}

DocumentWorkflowSettings — список элементов со свойствами вида документооборота, представленных структурой DocumentWorkflowSettingsV2.

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

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

GET /V2/GetWorkflowsSettings?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

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

{
    "DocumentWorkflowSettings": [
        {
            "Id": 1,
            "Participants": [
                {
                    "Participant": "Sender",
                    "ParticipantAction": "Title",
                    "TitleReceiptBehavior": "DefineByUser"
                },
                {
                    "Participant": "Proxy",
                    "ParticipantAction": "Signature",
                    "TitleReceiptBehavior": "Never"
                },
                {
                    "Participant": "Recipient",
                    "ParticipantAction": "OptionalSignature",
                    "TitleReceiptBehavior": "Never"
                }
            ],
            "OperatorConfirmationReceiptBehavior": "Never",
            "ReceiptOperatorConfirmationReceiptBehavior": "Never",
            "ReceiptOperatorConfirmationBehavior": "Never",
            "AmendmentRequestResponseBehavior": "None",
            "ReceiptRoamingConfirmationBehavior": "Never",
            "InvitationBehavior": "Never"
        },
        {
            "Id": 2,
            "Participants": [
                {
                    "Participant": "Sender",
                    "ParticipantAction": "Title",
                    "TitleReceiptBehavior": "DefineByUser"
                },
                {
                    "Participant": "Proxy",
                    "ParticipantAction": "Signature",
                    "TitleReceiptBehavior": "Never"
                },
                {
                    "Participant": "Recipient",
                    "ParticipantAction": "Signature",
                    "TitleReceiptBehavior": "Never"
                }
            ],
            "OperatorConfirmationReceiptBehavior": "Never",
            "ReceiptOperatorConfirmationReceiptBehavior": "Never",
            "ReceiptOperatorConfirmationBehavior": "Never",
            "AmendmentRequestResponseBehavior": "None",
            "ReceiptRoamingConfirmationBehavior": "Never",
            "InvitationBehavior": "Never"
        }
    ]
}

См. также

Инструкции:

Виды документооборота

Устаревшие версии метода:

GetWorkflowsSettings