Команда «СБИС.ВыполнитьДействие» выполняет указанный переход с выбранного этапа документооборота. Если переход предполагает подписание документов и ключ в этот момент доступен, команда предварительно загружает подписи к вложениям.
Адрес запроса: https://online.sbis.ru/service/?srv=1
Параметры запроса
** — условно-обязательный параметр.
- "Документ": объект:
- "Идентификатор"**: строка, идентификатор документа. Если выполняется этап документооборота для редакции документа, то параметр не передается
- "Редакция"**: объект. Обязателен, если выполняется этап документооборота для редакции документа
- "Этап"*: объект:
- "Исполнитель": объект:
- "Фамилия": строка
- "Имя": строка
- "Отчество": строка
- "Идентификатор": строка, табельный номер (идентификатор)
- "Подразделение": объект:
- "Название": строка, название подразделения
- "Идентификатор": строка, код подразделения
- "Название"**: строка, необязательна для некоторых этапов
- "Идентификатор"**: строка, необязательна для некоторых этапов "Отправка"
- "Действие"*: массив из одного объекта:
- "Название"*: строка
- "Комментарий"**: строка, обязательна, если требуется указать комментарий
- "Сертификат": объект. При серверном или отложенном подписании указывает на требуемый сертификат:
- "Отпечаток": строка, используется как фильтр для поиска сертификата
- "Ключ": объект
- "Тип"*: строка. Если используете для подписания отложенный сертификат, передайте запрос в поле «Сертификат.Ключ.Тип» и укажите тип сертификата: «Отложенный» или «ОтложенныйСПодтверждением».
- ...
- "СледующийЭтап": массив объектов, задает исполнителей для следующих этапов:
- "Идентификатор": строка, идентификатор этапа
- "Название": строка, название этапа
- "Исполнитель": массив объектов, задает исполнителей — конкретных сотрудников или подразделения:
- "Сотрудник": объект:
- "Идентификатор": строка, идентификатор сотрудника
- "Фамилия": строка
- "Имя": строка
- "Отчество": строка
- "Подразделение": объект:
- "Идентификатор": строка, идентификатор подразделения
- "Название": строка, название подразделения
- "Сотрудник": объект:
- "Вложение": массив объектов:
- "Идентификатор": строка
- "Файл": объект:
- "Имя": строка
- "Ссылка": ссылка на объект в файловом хранилище. Не допускается одновременное использование с параметром «ДвоичныеДанные»
- "ДвоичныеДанные": строка в кодировке Base64. Не допускается одновременное использование с параметром «Ссылка»
- "Подпись": массив объектов:
- "Файл": объект
- "Имя": строка
- "Ссылка": ссылка на объект в файловом хранилище. Не допускается одновременное использование с параметром «ДвоичныеДанные»
- "ДвоичныеДанные"*: строка в кодировке Base64. Не допускается одновременное использование с параметром «Ссылка»
- "Сертификат": объект
- "Доверенность": массив объектов
- "ИдентификаторМЧД"*: строка, 36-разрядный GUID из имени файла
- "СистемаХраненияМЧД": строка
- "ДействительнаС": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время начала действия доверенности
- "ДействительнаПо": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС», дата и время окончания действия доверенности
- "ВнутрНомер": строка
- "ИННДоверителя": строка
- "Доверенность": массив объектов
- "Файл": объект
- "Исполнитель": объект:
- "ДопПоля": строка, дополнительные параметры метода
Результат
- "Документ": объект:
- "Идентификатор": строка
- "Направление": строка
- "СсылкаДляНашаОрганизация": строка
- "СсылкаДляКонтрагент": строка
- "Состояние": объект:
- "Код": число
- "Название": строка
- "Примечание": строка
- "НеполнаяОбработка": строка
- "Сложное": строка
- "НашаОрганизация": объект:
- ...
- "Контрагент": объект:
- ...
- "Подразделение": объект:
- ...
- "Ответственный": объект:
- ...
- "Событие": массив объектов:
- "ДатаВремя": строка в формате «ДД.ММ.ГГГГ ЧЧ.ММ.СС»
- "Название": строка
- "Идентификатор": строка
- "Комментарий": строка
- "Вложение": массив объектов:
- ...
- "Этап": массив объектов:
- "Название": строка
- "Идентификатор": строка
- ...
- "Действие": массив объектов:
- "Название": строка
- ...
Комментарий
- Чтобы добавить вложения к документу, укажите их в «Этап.Вложения». При локальном подписании можно приложить электронные подписи.
При отправке через оператора ЭДО действует ограничение на число вложений по тарифу роумингу. Если для организации установлены разные лимиты, применяется наиболее жесткое ограничение. При выполнение команды «СБИС.ВыполнитьДействие» происходит:
- предварительный вызов «СБИС.ПодготовитьДействие»;
- передача информации о сертификате для подписания ЭП (объект «Этап.Действие.Сертификат»);
- передача файла подписи (объект «Этап.Вложение.Подпись.Файл.ДвоичныеДанные»).
После вызова «СБИС.ПодготовитьДействие» вы можете заменить сгенерированные сервером служебные вложения на свои. При этом укажите идентификаторы заменяемых вложений и передайте двоичные данные.
На этапах внешнего документооборота выполняется форматно-логический контроль пользовательских файлов.
В запросе команды должно быть заполнено поле «Документ.Идентификатор» или «Документ.Редакция.Идентификатор». При заполненном «Документ.Идентификатор» обрабатывается этап и действия последней редакции. Если заполнено поле «Документ.Редакция.Идентификатор», то обрабатывается этап и действия конкретной редакции.
В команде мы рекомендуем передавать идентификатор этапа и идентификатор редакции.
Не используйте адресацию по названию этапов. Это может привести к ошибкам:
- будет подготовлена неверная редакция документа — при адресации по идентификатору документа на момент вызова метода может появиться новая редакция;
- может быть создан одноименный этап — если одноименные этапы были переназначены текущему или другому пользователю.
Если для подписания документа используется ЭП на носителе, исключите отправку прочих входящих в формат полей, за исключением поля «Подпись».
- Если для подписания используется отложенный сертификат, передайте запрос в поле «Сертификат.Ключ.Тип» и укажите тип сертификата — «Отложенный» или «ОтложенныйСПодтверждением». Реквизиты сертификата не запоминаются. Этап будет обработан владельцем сертификата с использованием любого из доступных ему собственных или доверенных сертификатов, которые подходят под требования регламента.
Если функция «СБИС.ВыполнитьДействие» вызывается не для этапа подготовки к отправке документа, передайте в команде значение поля «Документ.Этап.Идентификатор». Оно может быть получено от вызова другой команды, например «СБИС.ПодготовитьДействие».
В крайнем случае можно указать «Документ.Этап.Название», но этот способ ненадежен. Он допускает подготовку к неверному этапу:- при отправке новой редакции документа;
- попытке подготовки этапа по предыдущей редакции.
- Чтобы обработать отдельные файлы этапа «Утверждение», в объект «Документ» передайте:
- в поле «ДопПоля» значение «СложноеУтверждение»;
- идентификаторы обрабатываемых файлов в список «Вложение» (если они в этом списке отсутствуют).
Примеры
Запрос с отложенным сертификатом без подтверждения
Запрос с отложенным сертификатом с подтверждением