Электронный документооборот

СБИС.ВыполнитьДействие

СБИС.ВыполнитьДействие

Команда «СБИС.ВыполнитьДействие» выполняет указанный переход с выбранного этапа документооборота. Если переход предполагает подписание документов, а ключ находится на носителе, команда предварительно загружает подписи к вложениям.

Адрес запроса: https://online.sbis.ru/service/?srv=1

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

  • "Документ": объект:
    • "Идентификатор"*: строка
    • Редакция": объект:
      • "Идентификатор"*: строка
    • "Этап"*: объект:
      • "Исполнитель": объект:
        • "Фамилия": строка
        • "Имя": строка
        • "Отчество": строка
        • "Идентификатор": строка, табельный номер (идентификатор)
      • "Подразделение": объект:
        • "Название": строка, название подразделения
        • "Идентификатор": строка, код подразделения
      • "Название"**: строка, необязательна для некоторых этапов
      • "Идентификатор"**: строка, необязательна для некоторых этапов "Отправка"
      • "Действие"*: массив из одного объекта:
        • "Название"*: строка
        • "Комментарий"**: строка, обязательна, если требуется указать комментарий
        • "Сертификат": объект. При серверном или отложенном подписании указывает на требуемый сертификат:
          • "Отпечаток": строка, используется как фильтр для поиска сертификата
          • "Ключ": объект
          • ...
        • "СледующийЭтап": массив объектов, задает исполнителей для следующих этапов:
          • "Идентификатор": строка, идентификатор этапа
          • "Название": строка, название этапа
          • "Исполнитель": массив объектов, задает исполнителей — конкретных сотрудников или подразделения:
            • "Сотрудник": объект:
              • "Идентификатор": строка, идентификатор сотрудника
              • "Фамилия": строка
              • "Имя": строка
              • "Отчество": строка
            • "Подразделение": объект:
              • "Идентификатор": строка, идентификатор подразделения,
              • "Название": строка, название подразделения
      • "Вложение": массив объектов:
        • "Идентификатор": строка
        • "Файл": объект:
          • "Имя": строка
          • "Ссылка": ссылка на объект в файловом хранилище. Не допускается одновременное использование с параметром «ДвоичныеДанные».
          • "ДвоичныеДанные": строка в кодировке Base64. Не допускается одновременное использование с параметром «Ссылка».
        • "Подпись": массив объектов:
          • "Файл": объект
            • "Имя": строка
            • "Ссылка": ссылка на объект в файловом хранилище. Не допускается одновременное использование с параметром «ДвоичныеДанные».
            • "ДвоичныеДанные": строка в кодировке Base64. Не допускается одновременное использование с параметром «Ссылка».

Результат

  • "Документ": объект:
    • "Идентификатор": строка
    • "Направление": строка
    • "СсылкаДляНашаОрганизация": строка
    • "СсылкаДляКонтрагент": строка
    • "Состояние": объект:
      • "Код": число
      • "Название": строка
      • "Примечание": строка
    • "НашаОрганизация": объект:
      • ...
    • "Контрагент": объект:
      • ...
    • "Подразделение": объект:
      • ...
    • "Ответственный": объект:
      • ...
    • "Событие": массив объектов:
      • "ДатаВремя": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС"
      • "Название": строка
      • "Идентификатор": строка
      • "Комментарий": строка
      • "Вложение": массив объектов:
        • ...
    • "Этап": массив объектов:
      • "Название": строка
      • "Идентификатор": строка
      • ...
      • "Действие": массив объектов:
        • "Название": строка
        • ...

* — обязательный параметр.

** — условно-обязательный параметр.

* — при использовании для подписания отложенного сертификата нужно передать запрос в поле «Сертификат.Ключ.Тип» и указать тип сертификата: «Отложенный» или «ОтложенныйСПодтверждением».

Комментарий

Выполнение команды «СБИС.ВыполнитьДействие» при подписании подразумевает:

  • предварительный вызов «СБИС.ПодготовитьДействие»;
  • обязательную передачу информации о сертификате для подписания ЭП (объект «Этап.Действие.Сертификат»).

После вызова «СБИС.ПодготовитьДействие» вы можете заменить сгенерированные сервером служебные вложения на свои. При этом укажите идентификаторы заменяемых вложений и передайте двоичные данные.

В запросе команды должно быть заполнено поле «Документ.Идентификатор» или «Документ.Редакция.Идентификатор». При заполненном «Документ.Идентификатор» обрабатывается этап и действия последней редакции. Если заполнено поле «Документ.Редакция.Идентификатор», то обрабатывается этап и действия конкретной редакции.

В команде мы рекомендуем передавать идентификатор этапа и идентификатор редакции.

Не используйте адресацию по названию этапов. При использовании такой адресации к этапу может быть подготовлена:

  • неверная редакция документа — при адресации по идентификатору документа на момент вызова метода может появиться новая редакция документа;
  • одноименный этап — если одноименные этапы были переназначены текущему или другому пользователю.

Если для подписания документа используется ЭП на носителе, исключите отправку прочих входящих в формат полей, за исключением поля «Подпись».

Если функция «СБИС.ВыполнитьДействие» вызывается не для этапа подготовки к отправке документа, передайте в команде значение поля «Документ.Этап.Идентификатор». Оно может быть получено от вызова другой команды, например «СБИС.ПодготовитьДействие».
В крайнем случае можно указать «Документ.Этап.Название», но этот способ ненадежен. Он допускает подготовку к неверному этапу:

  • при отправке новой редакции документа;
  • попытке подготовки этапа по предыдущей редакции.

В команде можно передавать новые неслужебные вложения. Для этого добавьте их к массиву «Этап.Вложение». При локальном подписании одновременно можно приложить электронные подписи.

Пример запроса

Пример ответа (успех)

Пример запроса c отложенным сертификатом без подтверждения

Пример запроса c отложенным сертификатом с подтверждением

Пример ответа с отложенным сертификатом