Docflows Actions API

Группа методов для выполнения действий над документооборотом.

Описание методов

Данный блок содержит подробное описание по каждому методу API.

[PATCH]/api/v3/docflows/{docflowId}

Создание файла действия над ДО.

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
docflowId	Да	Path	string(uuid)	Идентификатор документооборота, над которым производится действие.

Тело запроса

Тип запроса: application/json

Данные для создания файла действия над ДО.

Название	Обязат.	Тип	Описание
action	Да	Одна из: DocflowAllowedActions	Действие.
cancellationParams	Нет	string	Причина отклонения.
warrantNumber	Нет	string	Номер доверенности.
answerTitleInfo	Нет	Одна из: AnswerTitleInfo	Дополнительная информация из ответного титула.

Пример модели

{
  "action": "SignAutomaticTransactions",
  "cancellationParams": "Строка",
  "warrantNumber": "Строка",
  "answerTitleInfo": {
    "resultCode": 1,
    "acceptanceDate": "2022-02-11T13:03:05.670Z",
    "contentOperation": "Строка",
    "documentOnDisagreements": {
      "name": "Строка",
      "number": "Строка",
      "date": "2022-02-11T13:03:05.670Z"
    },
    "disagreementAdditionalInfoList": [
      {
        "id": "Строка",
        "value": "Строка"
      }
    ]
  }
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Файл действия над ДО.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.

[PATCH]/api/v2/docflows/{docflowId}

Создание файла действия над ДО.

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
docflowId	Да	Path	string(uuid)	Идентификатор документооборота, над которым производится действие.

Тело запроса

Тип запроса: multipart/form-data

Название	Обязат.	Тип
action	Да	DocflowAllowedActions
cancellationParams	Нет	string
warrantNumber	Нет	string

Пример модели

{
  "action": "SignAutomaticTransactions",
  "cancellationParams": "Строка",
  "warrantNumber": "Строка"
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Файл действия над ДО.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.

[POST]/api/v2/docflows/AttachActionSign/{documentId}

Прикрепление подписи к документу. В качестве идентификатора документа используйте имя файла, полученного в методе формирования действия.

Основной сценарий Осуществляет прикрепление подписи к сформированному синхронно документу.

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
documentId	Да	Path	string(uuid)	Идентификатор документа действия над ДО.

Тело запроса

Тип запроса: multipart/form-data

Название	Обязат.	Тип	Описание
documentSign	Да	string(binary)

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Действие успешно выполнено.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.

[PUT]/api/v1/docflows/{docflowId}/actions/sign

Принять документ (подписать документ).

Основной сценарий Подписать документ требующий ответа, а также сформировать ответный титул для формализованного ДО.
Код действия: DocflowAllowedActions.Sign

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
docflowId	Да	Path	string(uuid)	Идентификатор документооборота.
warrantNumber	Нет	Query	string	Номер доверенности.

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Действие успешно выполнено.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

[PUT]/api/v1/docflows/{docflowId}/actions/rejection

Отклонить документ.

Основной сценарий Отклонить документ с формированием уведомления об уточнении.
Код действия: DocflowAllowedActions.Reject

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
docflowId	Да	Path	string(uuid)	Идентификатор документооборота.
warrantNumber	Нет	Query	string	Номер доверенности.

Тело запроса

Тип запроса: application/json

Дополнительные параметры запроса.

Название	Обязат.	Тип	Описание
message	Да	string	Сообщение, содержащее причину отклонения документа.

Пример модели

{
  "message": "Причина отклонения документа."
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Действие успешно выполнено.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

[PUT]/api/v1/docflows/{docflowId}/actions/cancellation/request

Запросить анулирование документа.

Основной сценарий Сформировать аннулирование документа в связи с различными обстоятельствами.
Код действия: DocflowAllowedActions.RequestCancellation

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
docflowId	Да	Path	string(uuid)	Идентификатор документооборота.
warrantNumber	Нет	Query	string	Номер доверенности.

Тело запроса

Тип запроса: application/json

Дополнительные параметры запроса.

Название	Обязат.	Тип	Описание
message	Да	string	Сообщение, содержащее причину запроса на аннулирование.

Пример модели

{
  "message": "Причина аннулирования."
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Действие успешно выполнено.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

[PUT]/api/v1/docflows/{docflowId}/actions/cancellation/approval

Подтвердить запрос на аннулирование.

Основной сценарий Принять запрос на анулирование документа от контрагента-инициатора.
Код действия: DocflowAllowedActions.AcceptCancellation

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
docflowId	Да	Path	string(uuid)	Идентификатор документооборота.
warrantNumber	Нет	Query	string	Номер доверенности.

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Действие успешно выполнено.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

[PUT]/api/v1/docflows/{docflowId}/actions/cancellation/rejection

Отклонить запрос на аннулирование документа.

Основной сценарий Отклонить запрос на анулирования документа в связи с различными обстоятельствами.
Код действия: DocflowAllowedActions.RejectCancellation

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
docflowId	Да	Path	string(uuid)	Идентификатор документооборота.
warrantNumber	Нет	Query	string	Номер доверенности.

Тело запроса

Тип запроса: application/json

Дополнительные параметры запроса.

Название	Обязат.	Тип	Описание
message	Да	string	Сообщение, содержащее причину отклонения запроса на аннулирование.

Пример модели

{
  "message": "Причина отклонения запроса на аннулирование."
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Действие успешно выполнено.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

[GET]/api/v1/docflows/{docflowId}/actions

Получить список доступных действий над ДО.

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
docflowId	Да	Path	string(uuid)	Идентификатор документооборота, над которым производится действие.

Возможные ответы метода

Код	Тип	Описание
200	DocflowAllowedActionsResultList	Список доступных действий над документооборотом.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    "SignAutomaticTransactions"
  ]
}

[PUT]/api/v1/docflows/{docflowId}/actions/confirmReceipt

Создать подтверждение получения документа.

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

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
docflowId	Да	Path	string(uuid)	Идентификатор документооборота.
warrantNumber	Нет	Query	string	Номер доверенности.
confirmedTransactionId	Нет	Query	string(uuid)	ID транзакции на которую необходимо отправить ИоП.

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Действие успешно выполнено.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

[PUT]/api/v1/docflows/{docflowId}/actions/signAutomaticTransactions

Инициировать подпись служебных транзакций.

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

Название	Обязат.	Место	Тип	Описание
docflowId	Да	Path	string(uuid)	Идентификатор документооборота.
warrantNumber	Нет	Query	string	Номер доверенности.
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Действие успешно выполнено.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
404	Без данных	Ресурс не найден.
500	Без данных	Внутренняя ошибка сервера.

Описание дополнительных моделей

Данный блок содержит описание дополнительных моделей.

AnswerTitleInfo

Дополнительная информация из ответного титула.

Название	Обязат.	Тип	Описание
resultCode	Да	integer(int32)	Код, обозначающий итог приемки товара (работ, услуг, прав).
acceptanceDate	Да	date-time-offset	Дата принятия товаров.
contentOperation	Нет	string	Детальная информация.
documentOnDisagreements	Нет	Одна из: DocumentOnDisagreements	Реквизиты документа, оформляющего расхождения.
disagreementAdditionalInfoList	Нет	DisagreementAdditionalInfo[array]	Список ИнфПолФХЖ4.

Пример модели

{
  "resultCode": 1,
  "acceptanceDate": "2022-02-11T13:03:05.670Z",
  "contentOperation": "Строка",
  "documentOnDisagreements": {
    "name": "Строка",
    "number": "Строка",
    "date": "2022-02-11T13:03:05.670Z"
  },
  "disagreementAdditionalInfoList": [
    {
      "id": "Строка",
      "value": "Строка"
    }
  ]
}

CreateActionFileRequest

Запрос на создание файла действия над ДО.

Название	Обязат.	Тип	Описание
action	Да	Одна из: DocflowAllowedActions	Действие.
cancellationParams	Нет	string	Причина отклонения.
warrantNumber	Нет	string	Номер доверенности.
answerTitleInfo	Нет	Одна из: AnswerTitleInfo	Дополнительная информация из ответного титула.

Пример модели

{
  "action": "SignAutomaticTransactions",
  "cancellationParams": "Строка",
  "warrantNumber": "Строка",
  "answerTitleInfo": {
    "resultCode": 1,
    "acceptanceDate": "2022-02-11T13:03:05.670Z",
    "contentOperation": "Строка",
    "documentOnDisagreements": {
      "name": "Строка",
      "number": "Строка",
      "date": "2022-02-11T13:03:05.670Z"
    },
    "disagreementAdditionalInfoList": [
      {
        "id": "Строка",
        "value": "Строка"
      }
    ]
  }
}

DisagreementAdditionalInfo

ИнфПолФХЖ4.

Название	Обязат.	Тип	Описание
id	Да	string	Идентификатор
value	Да	string	Значение.

Пример модели

{
  "id": "Строка",
  "value": "Строка"
}

DocflowAllowedActions

Значение	Описание
AcceptCancellation	Принять аннулирование.
ConfirmReceipt	Подтвердить получение (отправить ИоП).
Print	Можно ли распечатать документ.
Reject	Отклонить документ.
RejectCancellation	Отклонить аннулирование.
RequestCancellation	Отправить запрос на аннулирование (ПоА).
Sign	Подписать документ.
SignAutomaticTransactions	Сформировать и подписать автоматическую служебную транзакцию.
VerifyMarkingCodes	Сверить коды маркировки.

DocflowAllowedActionsResultList

Список с результатом поиска.

Название	Обязат.	Тип	Описание
count	Да	integer(int32)	Количество элементов в результате.
data	Да	DocflowAllowedActions[array]	Список элементов в результате.

Пример модели

{
  "count": 1,
  "data": [
    "SignAutomaticTransactions"
  ]
}

DocumentOnDisagreements

Реквизиты документа, оформляющего расхождения.

Название	Обязат.	Тип	Описание
name	Да	string	Наименование документа.
number	Нет	string	Номер документа.
date	Да	date-time-offset	Дата документа.

Пример модели

{
  "name": "Строка",
  "number": "Строка",
  "date": "2022-02-11T13:03:05.670Z"
}

RejectCancellationRequest

Дополнительные параметры для отклонения запроса на аннулирование.

Название	Обязат.	Тип	Описание
message	Да	string	Сообщение, содержащее причину отклонения запроса на аннулирование.

Пример модели

{
  "message": "Причина отклонения запроса на аннулирование."
}

RejectDocumentRequest

Дополнительные параметры для отклонения документа.

Название	Обязат.	Тип	Описание
message	Да	string	Сообщение, содержащее причину отклонения документа.

Пример модели

{
  "message": "Причина отклонения документа."
}

RequestCancellationRequest

Дополнительные параметры для запроса на аннулирование.

Название	Обязат.	Тип	Описание
message	Да	string	Сообщение, содержащее причину запроса на аннулирование.

Пример модели

{
  "message": "Причина аннулирования."
}

Docflows Actions API

Описание методов​

[PATCH]/api/v3/docflows/{docflowId}​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[PATCH]/api/v2/docflows/{docflowId}​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[POST]/api/v2/docflows/AttachActionSign/{documentId}​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[PUT]/api/v1/docflows/{docflowId}/actions/sign​

Параметры в строке запроса​

Возможные ответы метода​

[PUT]/api/v1/docflows/{docflowId}/actions/rejection​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[PUT]/api/v1/docflows/{docflowId}/actions/cancellation/request​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[PUT]/api/v1/docflows/{docflowId}/actions/cancellation/approval​

Параметры в строке запроса​

Возможные ответы метода​

[PUT]/api/v1/docflows/{docflowId}/actions/cancellation/rejection​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[GET]/api/v1/docflows/{docflowId}/actions​

Параметры в строке запроса​

Возможные ответы метода​

[PUT]/api/v1/docflows/{docflowId}/actions/confirmReceipt​

Параметры в строке запроса​

Возможные ответы метода​

[PUT]/api/v1/docflows/{docflowId}/actions/signAutomaticTransactions​

Параметры в строке запроса​

Возможные ответы метода​

Описание дополнительных моделей​

AnswerTitleInfo​

CreateActionFileRequest​

DisagreementAdditionalInfo​

DocflowAllowedActions​

DocflowAllowedActionsResultList​

DocumentOnDisagreements​

RejectCancellationRequest​

RejectDocumentRequest​

RequestCancellationRequest​

Описание методов

[PATCH]/api/v3/docflows/{docflowId}

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

Тело запроса

Возможные ответы метода

[PATCH]/api/v2/docflows/{docflowId}

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

Тело запроса

Возможные ответы метода

[POST]/api/v2/docflows/AttachActionSign/{documentId}

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

Тело запроса

Возможные ответы метода

[PUT]/api/v1/docflows/{docflowId}/actions/sign

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

Возможные ответы метода

[PUT]/api/v1/docflows/{docflowId}/actions/rejection

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

Тело запроса

Возможные ответы метода

[PUT]/api/v1/docflows/{docflowId}/actions/cancellation/request

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

Тело запроса

Возможные ответы метода

[PUT]/api/v1/docflows/{docflowId}/actions/cancellation/approval

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

Возможные ответы метода

[PUT]/api/v1/docflows/{docflowId}/actions/cancellation/rejection

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

Тело запроса

Возможные ответы метода

[GET]/api/v1/docflows/{docflowId}/actions

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

Возможные ответы метода

[PUT]/api/v1/docflows/{docflowId}/actions/confirmReceipt

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

Возможные ответы метода

[PUT]/api/v1/docflows/{docflowId}/actions/signAutomaticTransactions

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

Возможные ответы метода

Описание дополнительных моделей

AnswerTitleInfo

CreateActionFileRequest

DisagreementAdditionalInfo

DocflowAllowedActions

DocflowAllowedActionsResultList

DocumentOnDisagreements

RejectCancellationRequest

RejectDocumentRequest

RequestCancellationRequest