Знак Oodrive (предварительная версия)

Подключение и использование службы подписей Oodrive с помощью рабочих процессов.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Знак Oodrive
URL https://www.oodrive.com/products/oodrive-sign/
Адрес электронной почты support-sign@oodrive.com
Метаданные соединителя
Publisher Знак Oodrive
Website https://www.oodrive.com/products/oodrive-sign/
Политика конфиденциальности https://www.oodrive.com/privacy-policy/
Категории ИТ-операции; Продуктивность

Соединитель подписи Oodrive позволяет автоматизировать задачи и легко управлять процессами о экосистеме электронных подписей. Автоматизированный рабочий процесс может быть создан, например, создать новый контракт по шаблону, автоматически добавить получателей и отправить контракт для подписи. Вы также можете управлять всеми пакетами, получателями, ключевыми параметрами и многое другое. Он предлагает клиентам возможность сократить время, используемое для выполнения ручных действий после всего процесса подписи. Все функции, доступные в веб-приложении, можно воспроизвести в Power Automate с помощью соединителя.

Предпосылки

Вам нужна учетная запись с платным планом в службе входа Oodrive.

Получение учетных данных

Кроме того, необходимо получить маркер API, который может быть вызван службой поддержки или его можно получить в приветственном сообщении электронной почты, отправленной в почтовый ящик при применении к службе входа.

Note: If you are a employee, you can get the token by contacting your IT service.

Начало работы с соединителем

Чтобы начать использовать соединитель, сначала необходимо открыть Power Automate с учетной записью Power Platform.

Note: you'll need to be premium on Power Automate in order to use the connector.

Выполните следующие действия, чтобы создать рабочий процесс и использовать наш соединитель:

  1. В среде Power Automate щелкните вкладку "Создать".
  2. При необходимости выберите "Автоматизированный поток облака" или "Мгновенный поток облака".
  3. Присвойте новому рабочему процессу имя и выберите триггер, соответствующий вашим потребностям. Вы можете использовать один из подписей Oodrive.
  4. Начните использовать соединитель, добавив действие из него, просто найдите "Oodrive Sign" в каталоге.
  5. При первом добавлении действия или триггера из нашего соединителя Power Automate попросит вас подключиться к вашей среде. Это значит, что вы будете использовать маркер API, предоставленный нами.
  6. Затем нажмите кнопку подключения: все готово, можно использовать столько действий из соединителя, которое требуется.

Известные проблемы и ограничения

Чтобы устранить проблемы с подписью Oodrive, обратитесь в службу поддержки.

Распространенные ошибки и средства устранения неполадок

ОШИБКА HTTP 404

Как правило, при получении ошибки 404 с знаком Oodrive вы говорите, что ресурс, который вы пытаетесь найти, не существует в вашей среде. Как правило, это может быть ошибка в идентификаторе, предоставленном для определенного контракта или конкретного получателя, который не существует. Чтобы устранить проблему, попробуйте использовать действие с известным идентификатором ресурса, который вы пытаетесь получить.

ОШИБКА HTTP 501

Ошибка HTTP 501 указывает, что служба входа Oodrive не распознала ваш запрос или что вы передали в службу неправильный тип данных. Попробуйте изучить, прочитав документацию по подписи, на данные, которые вы передаете в действие или триггер.

Часто задаваемые вопросы

1. Как отправить документ в конкретный контракт?

С помощью действия "Отправить документ и присоединить его к контракту" можно легко отправить pdf-файл, который удаленно сохранен.

Первый шаг требует получения содержимого файла, который требуется отправить. Его можно получить с помощью множества соединителей. Например, содержимое файла можно получить с помощью действия "Получить содержимое файла" соединителя SharePoint.

  1. Получите содержимое файла, который требуется отправить в виде документа для определенного контракта. В этом примере мы используем действие "Получить содержимое файла" соединителя SharePoint Online.
  2. Затем добавьте новое действие compose. Используйте выходной текст действия "Получить содержимое файла" в качестве входных данных для создания.
  3. Добавьте действие с именем "Отправить документ и добавить его в контракт" из соединителя подписи Oodrive.
    • В поле ввода "Идентификатор контракта" укажите идентификатор контракта, для которого требуется присоединить документ.
    • В поле ввода "Файлы" вставьте выходные данные предыдущего действия "Compose"
    • В поле ввода "Файлы (имя файла)" вставьте имя документа, который будет отправлен.
  4. Вы сделали отправку документа!

2. Можно ли просмотреть все контракты в моей среде?

Если маркер является маркером "администратор", да. В противном случае вы будете просматривать только контракт, к которому у вас есть доступ в обычном режиме.

3. У меня есть предложение для соединителя. Где я могу отправить его?

Вы можете отправить любые предложения о соединителе, обратившись в службу поддержки. Мы будем очень благодарны вашему вкладу!

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ API securestring Ключ API для этого API True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Вывод пакета

Снять весь контракт в пакете.
Вывод списка всех периметров

Извлеките все периметры, связанные с подключенной средой.
Вывод списка всех получателей

Получите всех получателей, связанных с текущей лицензией.
Вывод списка документов контракта

Получение всех документов, привязанных к контракту.
Вывод списка контрактов пакета

Извлеките все контракты из определенного пакета.
Вывод списка получателей контракта

Извлеките всех получателей для определенного контракта.
Добавление контракта в пакет

Добавьте существующий контракт в существующий пакет.
Добавление получателя в контракт

Присоединение существующего получателя к контракту.
Остановка транзакции контракта

Остановите транзакцию контракта, чтобы можно было изменить документы контракта и /или подписавшиеся.
Остановка транзакции пакета

Остановите транзакцию пакета.
Отзыв контракта

Задайте состояние контракта в значение ABANDONED, даже если контракт был отправлен для подписи.
Отправка вложения и добавление его в контракт

Отправьте новое вложение в среду и подключите его к конкретному контракту.
Отправка документа и его присоединение к контракту

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

Отправьте пакет для подписи.
Отправка подписанного контракта

Отправьте конкретный контракт и все его документы, подписанные получателями.
Отправка сообщения электронной почты повторного уведомления получателю

Отправьте сообщение электронной почты уведомления конкретному получателю для контракта.
Повторно отправьте сообщение электронной почты уведомления всем получателям

Отправьте уведомление всем получателям определенного контракта.
Получение определенного контракта

Получение метаданных определенного контракта.
Получение определенного получателя

Получите конкретного получателя в сохраненном списке получателей текущей среды.
Получение подписей контракта

Перечислить все сведения о подписях из определенного контракта.
Получение состояния контракта

Проверьте состояние конкретного контракта.
Получение списка всех контрактов

Извлеките все контракты из связанной лицензии.
Проверка контракта

Проверка (счетчик) контракта.
Проверка контрактов в пакете

Знак счетчика (проверка) всех контрактов в пакете.
Скачивание документов контракта

Получите PDF-файл, содержащий все документы из контракта.
Скачивание подписанного документа контракта

Получите pdf-файл из подписанного документа контракта.
Скачивание файла подтверждения контракта

Скачайте файл подтверждения контракта.
Создание контракта

Создайте новый контракт в среде.
Создание контракта и отправка его для подписи

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

Создайте новый пакет по крайней мере с одним существующим контрактом.
Удаление получателя контракта

Удаление получателя из контракта, его получателем для идентификатора контракта. Дополнительные сведения см. в документации.

Вывод пакета

Идентификатор операции:
WithdrawBundle

Снять весь контракт в пакете.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пакета
 id True string

Идентификатор пакета для отзыва всех контрактов.

Возвращаемое значение

Имя Путь Тип Описание
преуспевать
 succeed boolean

Говорит, если пакет был снят.

Вывод списка всех периметров

Идентификатор операции:
ListAllPerimeters

Извлеките все периметры, связанные с подключенной средой.

Возвращаемое значение

response
array of Perimeter

Вывод списка всех получателей

Идентификатор операции:
ListAllRecipients

Получите всех получателей, связанных с текущей лицензией.

Параметры

Имя Ключ Обязательно Тип Описание
Size
 size integer

Максимальный размер возвращаемого массива.
Смещение
 offset integer

Порядковый номер первого получателя.
Периметр
 perimeter string

Поиск только в заданном периметре.
Получение пользовательских реквизитов
 get_custom_props boolean

Список получателей настраиваемых свойств (увеличивает время отклика).
Получение периметров
 get_perimeters boolean

Вывод списка периметров получателя в ответах (увеличивает время отклика).
Фильтр фамилии (содержит)
 name string

Отфильтруйте фамилию.
Фильтрация электронной почты (содержит)
 email string

Фильтрация по электронной почте.

Возвращаемое значение

Получатели
array of Recipient

Вывод списка документов контракта

Идентификатор операции:
ListContractDocuments

Получение всех документов, привязанных к контракту.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для получения документов.

Возвращаемое значение

response
array of DocumentAdded

Вывод списка контрактов пакета

Идентификатор операции:
ListBundleContracts

Извлеките все контракты из определенного пакета.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пакета
 id True string

Идентификатор пакета, из которого извлекаются контракты.

Возвращаемое значение

response
array of ContractInBundle

Вывод списка получателей контракта

Идентификатор операции:
ListContractRecipients

Извлеките всех получателей для определенного контракта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для получения всех получателей.

Возвращаемое значение

response
array of ContractRecipient

Добавление контракта в пакет

Идентификатор операции:
AddContractToBundle

Добавьте существующий контракт в существующий пакет.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пакета
 id True string

Идентификатор пакета для добавления контракта.
Идентификатор контракта
 contract_id integer

Идентификатор контракта, добавляемого в пакет.

Возвращаемое значение

Тело
BundleResponse

Добавление получателя в контракт

Идентификатор операции:
AddRecipientToContract

Присоединение существующего получателя к контракту.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для присоединения получателя.
Идентификатор получателя
 recipient_id integer

Идентификатор получателя для присоединения к контракту.
Режим подписи
 signature_mode integer

Режим подписи. Дополнительные сведения см. в документации.
Заголовок сообщения
 message_title string

Заголовок сообщения для отправки по электронной почте, если будет один.
Содержимое сообщения
 message_body string

Текст сообщения для отправки по электронной почте, если будет один.
Ранг
 rank integer

Место получателя в процессе подписи. Ранжирование и Smartrole являются взаимоисключающими. Выберите только один из них или нет вообще.
Имя интеллектуальной роли
 smartrole string

Интеллектуальная роль для предоставления получателю. Дополнительные сведения см. в документации.
Способ транспортировки
 transport_mode integer

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

Возвращаемое значение

response
array of ContractRecipient

Остановка транзакции контракта

Идентификатор операции:
StopContract

Остановите транзакцию контракта, чтобы можно было изменить документы контракта и /или подписавшиеся.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для остановки.
Сила
 force boolean

Принудительное закрытие транзакции, даже если подписаны уже подписаны.

Возвращаемое значение

Имя Путь Тип Описание
преуспевать
 succeed boolean

Укажите, был ли отменен контракт.

Остановка транзакции пакета

Идентификатор операции:
StopBundleTransaction

Остановите транзакцию пакета.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пакета
 id True string

Идентификатор пакета для остановки транзакции.
Принудительное закрытие
 force boolean

Принудительное закрытие транзакции, даже если подписавшиеся уже подписали.

Возвращаемое значение

Имя Путь Тип Описание
преуспевать
 succeed boolean

Говорит, что пакет был успешно остановлен.

Отзыв контракта

Идентификатор операции:
WithdrawContract

Задайте состояние контракта в значение ABANDONED, даже если контракт был отправлен для подписи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для отзыва.
Причина
 reason string

Причина вывода.

Возвращаемое значение

Имя Путь Тип Описание
преуспевать
 succeed boolean

Укажите, был ли отменен контракт.

Отправка вложения и добавление его в контракт

Идентификатор операции:
UploadAttachmentAndAddToContract

Отправьте новое вложение в среду и подключите его к конкретному контракту.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для добавления вложения.
Идентификатор определения контракта
 contract_definition_id integer

Идентификатор определения контракта, определенный в вашей среде. Значение по умолчанию — pdfadhoc.
Имя определения параметра
 option_definition_name string

Имя определения.
Files
 file array

Файлы для добавления в виде вложений

Возвращаемое значение

Тело
AppendixAdded

Отправка документа и его присоединение к контракту

Идентификатор операции:
UploadDocumentAndAttachToContract

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для присоединения нового документа к нему.
Файл
 file file

Двоичный файл для отправки.

Возвращаемое значение

response
array of DocumentAdded

Отправка пакета для подписи

Идентификатор операции:
SendBundleForSignature

Отправьте пакет для подписи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пакета
 id True string

Идентификатор пакета для отправки подписи.

Возвращаемое значение

Имя Путь Тип Описание
преуспевать
 succeed boolean

Говорит, была ли отправлена транзакция или нет.

Отправка подписанного контракта

Идентификатор операции:
SendContractToBeSigned

Отправьте конкретный контракт и все его документы, подписанные получателями.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для отправки подписи.

Возвращаемое значение

Тело
Transaction

Отправка сообщения электронной почты повторного уведомления получателю

Идентификатор операции:
ResendNotificationRecipient

Отправьте сообщение электронной почты уведомления конкретному получателю для контракта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для повторного отправки уведомления.
Получатель для идентификатора контракта
 cfc_id True string

Идентификатор получателя для объекта контракта для отправки уведомления.

Возвращаемое значение

Имя Путь Тип Описание
преуспевать
 succeed boolean

Укажите, был ли уведомление успешно выполнено повторно.

Повторно отправьте сообщение электронной почты уведомления всем получателям

Идентификатор операции:
ResendNotificationAllRecipients

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для повторного отправки уведомления.

Возвращаемое значение

Имя Путь Тип Описание
преуспевать
 succeed boolean

Укажите, был ли уведомление успешно выполнено повторно.

Получение определенного контракта

Идентификатор операции:
GetSpecificContract

Получение метаданных определенного контракта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта, который требуется получить.

Возвращаемое значение

Тело
Contract

Получение определенного получателя

Идентификатор операции:
GetRecipient

Получите конкретного получателя в сохраненном списке получателей текущей среды.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор получателя
 id True string

Идентификатор извлекаемого получателя.

Возвращаемое значение

Тело
Recipient

Получение подписей контракта

Идентификатор операции:
ListSignatureStatus

Перечислить все сведения о подписях из определенного контракта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для перечисления всех подписей.

Возвращаемое значение

response
array of RecipientForContractWithRefusal

Получение состояния контракта

Идентификатор операции:
GetContractStatus

Проверьте состояние конкретного контракта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True integer

Идентификатор контракта для получения состояния.

Возвращаемое значение

Тело
Transaction

Получение списка всех контрактов

Идентификатор операции:
ListAllContracts

Извлеките все контракты из связанной лицензии.

Параметры

Имя Ключ Обязательно Тип Описание
Размер возвращаемого массива
 size integer

Максимальный размер возвращаемого массива контракта.
Пропуск первых n контрактов
 offset integer

Порядковый номер контракта, который будет пропущен.
Показать свойства контракта
 get_properties boolean

Если задано значение true, свойства контракта будут перечислены в ответе.
Отображение периметров контракта
 get_perimeters boolean

Если задано значение true, в ответе будут перечислены периметры контракта.
Создано раньше
 before integer

Будет перечислять контракт, созданный до указанной даты.
Создано после
 after integer

Будет перечислять контракт, созданный после заданной даты.
Только с периметром
 perimeter string

Вывод списка контрактов только в заданном периметре.
Только с состоянием
 status array

Получение контракта только с указанным состоянием.

Возвращаемое значение

Товары
ArrayOfContract

Проверка контракта

Идентификатор операции:
ValidateAContract

Проверка (счетчик) контракта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для проверки.
Сила
 force boolean

Укажите, должна ли проверка контракта быть принудительной, даже если некоторые подписи еще не подписаны.

Возвращаемое значение

Имя Путь Тип Описание
Дата проверки
 date string

Дата проверки.
Код проводки
 id string

Идентификатор транзакции центра сертификации.

Проверка контрактов в пакете

Идентификатор операции:
ValidateContractsInBundle

Знак счетчика (проверка) всех контрактов в пакете.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пакета
 id True string

Идентификатор пакета для проверки всех контрактов.
Принудительное проверка
 force boolean

Принудительно проверить контракты, если некоторые подписи еще не подписали (или отказались подписать).

Возвращаемое значение

Имя Путь Тип Описание
array of object
date
 date string

Дата закрытия.
Идентификатор контракта
 id string

Идентификатор контракта остановлен.

Скачивание документов контракта

Идентификатор операции:
DownloadContractDocuments

Получите PDF-файл, содержащий все документы из контракта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для получения pdf-файла.
Имя выходного файла
 filename string

Имя файла, который будет скачан.

Возвращаемое значение

Двоичный файл PDF-документа
file

Скачивание подписанного документа контракта

Идентификатор операции:
DownloadContractSignedDocument

Получите pdf-файл из подписанного документа контракта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True integer

Идентификатор контракта, содержащего документы.
Имя файла
 filename string

Имя, которое необходимо предоставить скачанным документу.

Возвращаемое значение

Двоичное содержимое pdf-файла.

Двоичный файл документа
file

Скачивание файла подтверждения контракта

Идентификатор операции:
DownloadProofFileContract

Скачайте файл подтверждения контракта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 id True string

Идентификатор контракта для скачивания файла подтверждения.
Имя выходного файла
 filename string

Имя файла, который будет скачан.

Возвращаемое значение

response
file

Создание контракта

Идентификатор операции:
CreateNewContract

Создайте новый контракт в среде.

Параметры

Имя Ключ Обязательно Тип Описание
Имя контракта
 name string

Имя только что созданного контракта (обязательно).
Идентификатор определения контракта
 contract_definition_id integer

Идентификатор определения контракта. Обратитесь к переменной API лицензии. По умолчанию используется шаблон ADHoc PDF.
Электронная почта поставщика
 vendor_email string

Электронная почта владельца лицензии.
Дата создания
 date integer

Дата контракта. По умолчанию — Date.Now(). Должен находиться в миллисекундах.
Заголовок сообщения
 message_title string

Объект отправленного сообщения электронной почты. Оставьте пустым заголовок по умолчанию.
Текст сообщения
 message_body string

Текст отправленного сообщения электронной почты. Оставьте пустым сообщение по умолчанию.
Продолжайте двигаться
 keep_on_move boolean

Активация или отключение подписи на мобильном устройстве
Автоматическое закрытие
 auto_close integer

Укажите, выполняется ли счетчик без вмешательства человека.
Последовательный
 sequential boolean

Укажите, если последовательный или нет.
Номер клиента
 customer_number string

Только для устаревших мобильных приложений.
Список периметра
 perimeters array of string
Идентификатор определения элемента
 element_definition_id integer

Идентификатор определения элемента.
Ценность
 value string

Значение параметра элемента.
Идентификатор свойства
 id integer

Идентификатор пользовательского свойства.
Ключ свойства
 key string

Ключ пользовательского свойства.
Заполнитель свойства
 placeholder string

Метка, отображаемая получателю при приглашении на заполнение свойства.
Значение свойства
 value string

Значение настраиваемого свойства.
Идентификатор контракта свойства
 contract_id integer

Идентификатор контракта, связанного с этим пользовательским свойством.
Требуется свойство
 to_fill_by_user boolean

Укажите, нужно ли пользователю заполнить свойство или нет.
Тип свойства
 field_type string

Укажите тип настраиваемого свойства. Дополнительные сведения в документации.
Варианты свойств
 input_filter string

Список возможных вариантов для свойства.
Свойство используется контрактом
 used_by_contract boolean

Установите значение true, если сведения должны отображаться в документе контракта.
Требуется свойство
 required boolean

Укажите, является ли свойство обязательным или нет.

Возвращаемое значение

Тело
Contract

Создание контракта и отправка его для подписи

Идентификатор операции:
AllInOneCreateContract

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 contract_id integer

Идентификатор контракта.
Дата создания
 date integer

Дата создания контракта.
Адрес электронной почты поставщика
 vendor_email string

Адрес электронной почты владельца лицензии Oodrive.
Идентификатор определения контракта
 contract_definition_id integer

Идентификатор определения контракта, используемого для этого контракта.
Тема сообщения
 message_title string

Тема электронной почты при отправке подписи.
Текст сообщения
 message_body string

Текст электронной почты при отправке подписи.
Имя контракта
 name True string

Имя основного документа контракта.
Активация автономной подписи
 keep_on_move boolean

Определите, активируется ли автономная подпись на мобильном устройстве.
Дата закрытия контракта
 closed_date integer

Дата закрытия контракта, если есть.
Отмена контракта
 canceled_reason string

Причина отмены, если есть.
Автоматическое закрытие включено
 auto_close integer

Укажите, будет ли контракт автоматически назначен или требуется вмешательство человека.
Удаляется
 deleted integer

Укажите, был ли контракт удален или нет.
Ключ периметра
 Perimeters string

Ключ периметра.
Идентификатор параметра
 id integer

Идентификатор параметра контракта.
Идентификатор контракта
 contract_id integer

Идентификатор контракта, привязанного к этому параметру.
Идентификатор определения элемента
 element_definition_id integer

Идентификатор определения элемента параметра.
Таймер синхронизации
 sync_timer integer

Таймер, используемый для проблемы с синхронизацией.
Значение параметра
 value string

Значение параметра.
Последнее изменение места
 last_modification_place string

Указывает, где произошло последнее изменение.
Элемент управления параметром
 control string

Поле управления.
Идентификатор свойства
 id integer

Идентификатор пользовательского свойства.
Ключ свойства
 key string

Ключ пользовательского свойства.
Заполнитель свойства
 placeholder string

Метка, отображаемая получателю при приглашении на заполнение свойства.
Значение свойства
 value string

Значение настраиваемого свойства.
Идентификатор контракта свойства
 contract_id integer

Идентификатор контракта, связанного с этим пользовательским свойством.
Требуется свойство
 to_fill_by_user boolean

Укажите, нужно ли пользователю заполнить свойство или нет.
Тип свойства
 field_type string

Укажите тип настраиваемого свойства. Дополнительные сведения в документации.
Варианты свойств
 input_filter string

Список возможных вариантов для свойства.
Свойство используется контрактом
 used_by_contract boolean

Установите значение true, если сведения должны отображаться в документе контракта.
Требуется свойство
 required boolean

Укажите, является ли свойство обязательным или нет.
Режим подписи
 signature_mode integer
имя
 firstname string
фамилия
 lastname string
электронная почта
 email string
cell_phone
 cell_phone string
pdfparts
 pdfparts string
приложения
 appendixparts string

Возвращаемое значение

Имя Путь Тип Описание
recipients
 recipients array of Recipient
recipientForcontract
 recipientForcontract array of ContractRecipient
контракт
 contract Contract
Формат pdf
 pdfparts array of object

Массив PDF-файла, привязанный к контракту.
ИДЕНТИФИКАТОР PDF
 pdfparts.id integer

Идентификатор PDF-файла.
Ранг PDF
 pdfparts.rank integer

Ранг PDF- файла.
Имеет SmartFields
 pdfparts.has_smart_field boolean

Укажите, есть ли смарт-поля в контракте.
Размер PDF
 pdfparts.size integer

Размер документа.
Имя файла
 pdfparts.filename string

Имя pdf-файла.
приложения
 appendixparts array of object
id
 appendixparts.id integer

Создание пакета

Идентификатор операции:
CreateNewBundle

Создайте новый пакет по крайней мере с одним существующим контрактом.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор контракта
 contract_id integer

Идентификатор первого контракта пакета.
Те же подписи
 same_signatories boolean

Установите значение false, если контракты в пакете не имеют того же набора подписантов.

Возвращаемое значение

Тело
BundleResponse

Удаление получателя контракта

Идентификатор операции:
DeleteRecipientForContract

Удаление получателя из контракта, его получателем для идентификатора контракта. Дополнительные сведения см. в документации.

Параметры

Имя Ключ Обязательно Тип Описание
Получатель для идентификатора контракта
 cfc_id True string

Идентификатор получателя для удаления объекта контракта.

Возвращаемое значение

Имя Путь Тип Описание
преуспевать
 succeed boolean

Укажите, успешно ли удалено.

Триггеры

Изменение состояния контракта

Эта операция активируется всякий раз, когда состояние контракта изменилось.

Изменение состояния контракта

Идентификатор операции:
WhenContractStatusChanged

Эта операция активируется всякий раз, когда состояние контракта изменилось.

Параметры

Имя Ключ Обязательно Тип Описание
описание
 description string

описание
events
 events array of string

events
contractDefinition
 contractDefinition array of integer

contractDefinition
периметр
 perimeter array of integer

периметр
обеспокоенныйUserEmail
 concernedUserEmail string

обеспокоенныйUserEmail

Возвращаемое значение

Имя Путь Тип Описание
type
 type string

type
contractId
 contractId integer

contractId
отметка времени
 timestamp integer

отметка времени
contractStatus
 contractStatus string

contractStatus

Определения

ArrayOfContract

Имя Путь Тип Описание
Товары
 Contract

Контракт

Имя Путь Тип Описание
Идентификатор контракта
 contract_id integer

Идентификатор контракта.
Дата создания
 date integer

Дата создания контракта.
Маркер документа
 document_token string

Маркер основного документа контракта.
Адрес электронной почты поставщика
 vendor_email string

Адрес электронной почты владельца лицензии Oodrive.
Закрыто
 closed boolean

Укажите, закрыт ли контракт.
Состояние контракта
 status string

Текущее состояние контракта.
Идентификатор определения контракта
 contract_definition_id integer

Идентификатор определения контракта, используемого для этого контракта.
Тема сообщения
 message_title string

Тема электронной почты при отправке подписи.
Текст сообщения
 message_body string

Текст электронной почты при отправке подписи.
Имя контракта
 name string

Имя основного документа контракта.
Активация автономной подписи
 keep_on_move boolean

Определите, активируется ли автономная подпись на мобильном устройстве.
Дата закрытия контракта
 closed_date integer

Дата закрытия контракта, если есть.
Отмена контракта
 canceled_reason string

Причина отмены, если есть.
Номер версии контракта
 version_number integer

Номер версии контракта.
Размер контракта
 size integer

Полный размер контракта.
Автоматическое закрытие включено
 auto_close integer

Укажите, будет ли контракт автоматически назначен или требуется вмешательство человека.
Удаляется
 deleted integer

Укажите, был ли контракт удален или нет.
Периметров
 perimeters array of ContractPerimeterKey

Список всех периметров контракта (при запросе).
Options
 options array of ContractOption

Список всех определенных параметров контракта (при запросе).
Пользовательские свойства
 contract_properties array of ContractProperty

Список всех необязательных свойств контракта (при запросе).

ContractOption

Имя Путь Тип Описание
Идентификатор параметра
 id integer

Идентификатор параметра контракта.
Идентификатор контракта
 contract_id integer

Идентификатор контракта, привязанного к этому параметру.
Идентификатор определения элемента
 element_definition_id integer

Идентификатор определения элемента параметра.
Таймер синхронизации
 sync_timer integer

Таймер, используемый для проблемы с синхронизацией.
Значение параметра
 value string

Значение параметра.
Последнее изменение места
 last_modification_place string

Указывает, где произошло последнее изменение.
Элемент управления параметром
 control string

Поле управления.

ContractProperty

Имя Путь Тип Описание
Идентификатор свойства
 id integer

Идентификатор пользовательского свойства.
Ключ свойства
 key string

Ключ пользовательского свойства.
Заполнитель свойства
 placeholder string

Метка, отображаемая получателю при приглашении на заполнение свойства.
Значение свойства
 value string

Значение настраиваемого свойства.
Идентификатор контракта свойства
 contract_id integer

Идентификатор контракта, связанного с этим пользовательским свойством.
Требуется свойство
 to_fill_by_user boolean

Укажите, нужно ли пользователю заполнить свойство или нет.
Тип свойства
 field_type string

Укажите тип настраиваемого свойства. Дополнительные сведения в документации.
Варианты свойств
 input_filter string

Список возможных вариантов для свойства.
Свойство используется контрактом
 used_by_contract boolean

Установите значение true, если сведения должны отображаться в документе контракта.
Требуется свойство
 required boolean

Укажите, является ли свойство обязательным или нет.

ContractPerimeterKey

Ключ периметра.

Ключ периметра.

Ключ периметра
string

ContractRecipient

Имя Путь Тип Описание
Получатель для идентификатора контракта
 recipient_for_contract_id integer

Уникальный идентификатор контракта пары и получателя.
Идентификатор получателя
 recipient_id integer

Идентификатор получателя.
Идентификатор контракта
 contract_id integer

Идентификатор контракта.
Состояние подписи
 signature_status string

Состояние знака.
Дата подписи
 signature_date integer

Метка времени для даты знака знака.
Режим подписи
 signature_mode integer

Режим подписи.
Заголовок сообщения
 message_title string

Заголовок сообщения.
Содержимое сообщения
 message_body string

Текст сообщения.
Ранг
 rank integer

Ранжирование в процессе входа.
Интеллектуальная роль
 smartrole string

Смарт-роль, связанная с получателем.
Способ транспортировки
 transport_mode integer

Режим транспорта.
Идентификатор подписи
 signature_id string

Идентификатор подписи от получателя.

DocumentAdded

Имя Путь Тип Описание
Идентификатор документа
 id integer

Идентификатор документа.
Ранг
 rank integer

Поместите в список документов.
Имеет SmartField
 has_smart_field boolean

Укажите, имеет ли документ SmartFields.
Размер документа
 size integer

Размер документа в байтах.
Имя документа
 filename string

Имя документа.

Транзакция

Имя Путь Тип Описание
Идентификатор транзакции контракта
 transaction_id string

Укажите идентификатор транзакции, привязанный к контракту.
Закрыто
 is_closed boolean

Укажите, закрыт ли контракт.
Имя контракта
 contract_name string

Имя контракта.
Состояние контракта
 status string

Укажите состояние контракта.

Периметр

Имя Путь Тип Описание
Идентификатор периметра
 id integer

Идентификатор периметра.
Ключ периметра
 key string

Ключ периметра (используется контрактами).
описание
 description string

Описание периметра.

RecipientForContractWithRefusal

Имя Путь Тип Описание
Получатель для идентификатора контракта
 recipient_for_contract_id integer

Идентификатор объекта, привязанного к контракту и получателю.
Идентификатор получателя
 recipient_id integer

Идентификатор получателя подписи.
Состояние подписи
 signature_status string

Состояние подписи.
Дата подписи
 signature_date integer

Дата последних изменений подписи.
Режим подписи
 signature_mode integer

Режим подписи.
Заголовок сообщения
 message_title string

Заголовок сообщения, привязанного к подписи контракта.
Содержимое сообщения
 message_body string

Текст сообщения, привязанного к подписи контракта.
Ранг
 rank integer

Ранг получателя подписи в процессе контракта.
Имя интеллектуальной роли
 smartrole string

Роль получателя подписи в контракте.
Способ транспортировки
 transport_mode integer

Транспортный режим контракта, привязанный к подписи.
Идентификатор подписи
 signature_id string

Идентификатор подписи.
Имеет отказ
 has_refusal boolean

Укажите, отказался ли получатель от контракта.
Дата последнего отказа
 last_refusal_date integer

Укажите дату отказа.
Последнее сообщение об отказе
 last_refusal_message string

Укажите сообщение об отказе.

ContractInBundle

Имя Путь Тип Описание
Идентификатор контракта
 id integer

Идентификатор контракта.
Имя контракта
 name string

Имя контракта.
Тип определения контракта
 contract_definition_type string

Тип определения контракта.
Идентификатор определения контракта
 contract_definition_id integer

Идентификатор определения контракта.
Название компании
 company_name string

Имя компании, привязанной к контракту.

Recipient

Имя Путь Тип Описание
Идентификатор получателя
 id integer

Идентификатор получателя.
Вежливость
 civility string

Цивилизованность получателя
Имя (Первое имя)
 firstname string

Имя получателя.
Фамилия
 lastname string

Фамилия получателя.
Основной адрес
 address_1 string

Основной почтовый адрес получателя.
Почтовый индекс
 postal_code string

Почтовый индекс получателя.
Город
 city string

Город получателя.
Номер мобильного телефона
 cell_phone string

Номер мобильного телефона получателя.
Адрес почты
 email string

Адрес почты получателя.
Страна
 country string

Страна получателя.
Вторичный адрес
 address_2 string

Вторичный почтовый адрес получателя.
Название компании
 company_name string

Имя компании получателя.
Номер телефона
 phone string

Номер телефона получателя.
Должность
 job_title string

Название задания получателя.
Birthdate
 birthdate integer

Дата рождения (метка времени) получателя.
Место рождения
 birthplace string

Место рождения получателя.
custom_properties
 custom_properties array of RecipientProperty
Периметров
 perimeters array of string

RecipientProperty

Имя Путь Тип Описание
Идентификатор свойства
 id integer

Идентификатор свойства.
Ключ свойства
 key string

Ключ свойства.
Значение свойства
 value string

Значение свойства.
Идентификатор подрядчика
 contractor_id integer

Идентификатор подрядчика.
Таймер синхронизации
 sync_timer integer

Таймер последней синхронизации.
Последнее изменение места
 last_modification_place string

Расположение последнего изменения.

ПриложениеAdded

Имя Путь Тип Описание
Идентификатор приложения
 id integer

Идентификатор приложения.
Имя приложения
 filename string

Имя приложения.
Идентификатор параметра приложения
 option_id integer

Идентификатор параметра для приложения
Тип контента приложения
 content_type string

Тип содержимого приложения (например, image/jpeg).

BundleResponse

Имя Путь Тип Описание
Идентификатор пакета
 id integer

Идентификатор пакета.
Идентификатор автора
 actor_id integer

Идентификатор создателя пакета.
Первый идентификатор контракта
 contract_id integer

Идентификатор первого контракта созданного пакета.
Состояние пакета
 status integer

Состояние пакета.
Главный пакет
 master integer

Мастер пакета.

file

Это базовый тип данных file.