GetWorkflowsSettings (V3)
Различия версий метода GetWorkflowsSettings
| Версия | Особенности |
|---|---|
| V3 | Поддерживает многотитульные документы и возвращает список структур DocumentWorkflowSettingsV3 |
| V2 | Применим для одно-, двух- и трехтитульных документов и возвращает список структур DocumentWorkflowSettingsV2 |
Возвращает свойства всех видов документооборота, в том числе для многотитульных документов.
GET /V3/GetWorkflowsSettings
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен.404— не найден ящик с указанным идентификатором.405— используется неподходящий HTTP-метод.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит список элементов со свойствами вида документооборота, представленный структурой DocumentWorkflowSettingsListV3.
Примеры использования
Пример HTTP-запроса:
GET /V3/GetWorkflowsSettings?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример тела ответа:
{
"DocumentWorkflowSettings": [
{
"Id": 1,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
},
{
"Participant": "Proxy",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Signature",
"TitleReceiptBehavior": "Never"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "OptionalSignature",
"TitleReceiptBehavior": "Never"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 2,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
},
{
"Participant": "Proxy",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Signature",
"TitleReceiptBehavior": "Never"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Signature",
"TitleReceiptBehavior": "Never"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 3,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
},
{
"Participant": "Proxy",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Signature",
"TitleReceiptBehavior": "Never"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 1,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 4,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Always"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Always",
"ReceiptOperatorConfirmationReceiptBehavior": "Always",
"ReceiptOperatorConfirmationBehavior": "Initiator",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 5,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Always"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 1,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Never"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Always",
"ReceiptOperatorConfirmationReceiptBehavior": "Always",
"ReceiptOperatorConfirmationBehavior": "Initiator",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 6,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
},
{
"Participant": "Proxy",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Signature",
"TitleReceiptBehavior": "Never"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 7,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "OptionalSignature",
"TitleReceiptBehavior": "Never"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "OperatorConfirmation",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Always"
},
{
"Id": 8,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Never"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 1,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Never"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "DefineByUser"
},
{
"Id": 9,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
},
{
"Participant": "Proxy",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Signature",
"TitleReceiptBehavior": "Never"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 10,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Always"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Always",
"ReceiptOperatorConfirmationReceiptBehavior": "Always",
"ReceiptOperatorConfirmationBehavior": "Initiator",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 11,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
},
{
"Participant": "Proxy",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Signature",
"TitleReceiptBehavior": "Never"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 1,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 12,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Always"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 1,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Never"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Always",
"ReceiptOperatorConfirmationReceiptBehavior": "Always",
"ReceiptOperatorConfirmationBehavior": "Initiator",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 13,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
},
{
"Participant": "Proxy",
"Actions": [
{
"TitleIndex": 1,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Never"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 2,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Never"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "Receipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 14,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Always"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Signature",
"TitleReceiptBehavior": "Never"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 15,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Always"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "InitiatorCounterpart",
"AmendmentRequestResponseBehavior": "OperatorConfirmation",
"ReceiptRoamingConfirmationBehavior": "Always",
"InvitationBehavior": "Never"
},
{
"Id": 16,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Always"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 1,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "InitiatorCounterpart",
"AmendmentRequestResponseBehavior": "OperatorConfirmation",
"ReceiptRoamingConfirmationBehavior": "Always",
"InvitationBehavior": "Never"
},
{
"Id": 17,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Always"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "InitiatorCounterpart",
"AmendmentRequestResponseBehavior": "OperatorConfirmation",
"ReceiptRoamingConfirmationBehavior": "Always",
"InvitationBehavior": "Never"
},
{
"Id": 18,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Always"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 1,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "InitiatorCounterpart",
"AmendmentRequestResponseBehavior": "OperatorConfirmation",
"ReceiptRoamingConfirmationBehavior": "Always",
"InvitationBehavior": "Never"
},
{
"Id": 19,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
},
{
"Participant": "Proxy",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Signature",
"TitleReceiptBehavior": "Never"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 1,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
},
{
"Id": 20,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 1,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "InitiatorCounterpart",
"AmendmentRequestResponseBehavior": "OperatorConfirmation",
"ReceiptRoamingConfirmationBehavior": "Always",
"InvitationBehavior": "Never"
},
{
"Id": 21,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "DefineByUser"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "InitiatorCounterpart",
"AmendmentRequestResponseBehavior": "OperatorConfirmation",
"ReceiptRoamingConfirmationBehavior": "Always",
"InvitationBehavior": "Never"
},
{
"Id": 22,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Never"
},
{
"TitleIndex": 2,
"ParticipantAction": "OptionalTitle",
"TitleReceiptBehavior": "Never"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 1,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Never"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "DefineByUser"
},
{
"Id": 23,
"Participants": [
{
"Participant": "Sender",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Title",
"TitleReceiptBehavior": "Always"
}
]
},
{
"Participant": "Recipient",
"Actions": [
{
"TitleIndex": 0,
"ParticipantAction": "Signature",
"TitleReceiptBehavior": "Never"
}
]
}
],
"OperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationReceiptBehavior": "Never",
"ReceiptOperatorConfirmationBehavior": "Never",
"AmendmentRequestResponseBehavior": "OperatorConfirmationOrReceipt",
"ReceiptRoamingConfirmationBehavior": "Never",
"InvitationBehavior": "Never"
}
]
}
См. также
Инструкции: