Интеграция с информационной системой

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

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

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

Адрес для выполнения запроса: https://online.sbis.ru/service/?srv=1

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

  • "Документ": объект:
    • "Идентификатор"*: строка
    • Редакция": объект:
      • "Идентификатор"*: строка
    • "Этап"*: объект:
      • "Исполнитель": объект:

        • "Фамилия": строка

        • "Имя": строка

        • "Отчество": строка

        • "Идентификатор": строка, табельный номер (идентификатор)

      • "Подразделение": объект:

        • "Название": строка, название подразделения

        • "Идентификатор": строка, код подразделения

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

Комментарий

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

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

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

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

Рекомендуется передавать идентификатор этапа и идентификатор редакции.

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

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

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

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

Результат запроса

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

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

Настройки прав доступа

Для выполнение команды СБИС.ВыполнитьДействие у пользователя внешнего API-интерфейса в кабинете СБИС должны быть настроены права на изменение документов (уровень доступа «Полный» или «Администрирование»).

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

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