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

GetWorkflowsSettings (V2)

подсказка

Для этого метода существует новая версия — GetWorkflowsSettings (V3). В интеграционных решениях рекомендуем использовать именно ее.

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

GET /V2/GetWorkflowsSettings

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

  • boxId — идентификатор ящика организации в формате GUID.

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

Коды ответа

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

Тело ответа

Тело ответа содержит список элементов со свойствами вида документооборота, представленный структурой 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

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

{
"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"
}
]
}

См. также

Инструкции:

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

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

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