Знак Adobe Acrobat

Adobe является самой надежной службой цифрового подписывания документов в мире. С помощью Adobe Acrobat Sign вы можете преобразовать процессы вручную в все цифровые интерфейсы. Включите функции Adobe Acrobat Sign в любимые приложения для создания, отправки и мониторинга состояния соглашений.

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

Услуга	Class	Регионы
Copilot Studio	Стандарт	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Стандарт	Все регионы Power Apps , кроме следующих:      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Power Automate	Стандарт	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)

Контакт
Имя	Поддержка подписей Adobe Acrobat
URL	https://helpx.adobe.com/contact/enterprise-support.dc.html#sign
Адрес электронной почты	support@echosign.zendesk.com

Метаданные соединителя
Publisher	ADOBE INC.
Website	https://acrobat.adobe.com/us/en/sign.html
Политика конфиденциальности	https://www.adobe.com/privacy/policy.html
Категории	Website

Знак Adobe Acrobat

Adobe является самой надежной службой цифрового подписывания документов в мире. С помощью Adobe Acrobat Sign вы можете преобразовать процессы вручную в все цифровые интерфейсы. Включите функции Adobe Acrobat Sign в любимые приложения для создания, отправки и мониторинга состояния соглашений.

Издатель: Adobe, Inc.

Предпосылки

Требуется учетная запись входа Adobe Acrobat.

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

N/A

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

Руководство пользователя соединителя https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

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

N/A

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

N/A

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

Руководство пользователя соединителя https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

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

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

Действия

Отмена соглашения	Отменяет соглашение, определенное по соглашению, в пути.
Отправка документа и получение идентификатора документа	Эта операция отправляет документ в учетную запись Adobe Acrobat Sign и возвращает для него идентификатор документа. Этот документ временно хранится в Adobe Acrobat Sign и идентификатор документа можно использовать для дальнейших операций, таких как создание соглашения.
Отправка документа и получение идентификатора документа (старый) [DEPRECATED]	Эта операция отправляет документ в учетную запись Adobe Acrobat Sign и возвращает для него идентификатор документа. Этот документ временно хранится в Adobe Acrobat Sign и идентификатор документа можно использовать для дальнейших операций, таких как создание соглашения.
Получение PDF-файла аудита соглашения	Эта операция извлекает поток PDF-файлов аудита соглашения. Обратите внимание, что поток файлов должен храниться с именем файла, заканчивающимся расширением .pdf файла.
Получение PDF-файла подписанного соглашения	Эта операция извлекает поток PDF-файлов объединенного или подписанного соглашения. Обратите внимание, что поток файлов должен храниться с именем файла, заканчивающимся расширением .pdf файла.
Получение PDF-файла подписанного соглашения [DEPRECATED]	Это действие устарело. Вместо этого используйте PDF-файл подписанного соглашения . Эта операция извлекает поток PDF-файлов объединенного или подписанного соглашения. Обратите внимание, что поток файлов должен храниться с именем файла, заканчивающимся расширением .pdf файла.
Получение URL-адреса подписи	Эта операция извлекает URL-адрес страницы e-sign для текущего подписывателя соглашения.
Получение URL-адреса представления соглашения	Получает последний URL-адрес представления состояния соглашения.
Получение данных поля формы соглашения (Старое) [DEPRECATED]	Извлекает данные, введенные в поля интерактивной формы соглашения.
Получение данных поля формы соглашения в формате CSV	Извлекает данные, введенные в поля интерактивной формы соглашения.
Получение данных поля формы соглашения в формате JSON	Извлекает данные, введенные в поля интерактивной формы соглашения.
Получение документа из соглашения	Эта операция получает файловый поток определенного документа соглашения.
Получение документа из соглашения [DEPRECATED]	Это действие устарело. Вместо этого используйте документ из соглашения . Эта операция получает файловый поток определенного документа соглашения.
Получение подробных сведений о рабочем процессе	Эта операция извлекает подробные сведения о рабочем процессе.
Получение состояния соглашения	Эта операция получает все текущие сведения о соглашении, например состояние.
Получение состояния соглашения [DEPRECATED]	Это действие устарело. Используйте вместо этого состояние соглашения . Эта операция получает все текущие сведения о соглашении, например состояние.
Получение списка всех веб-форм	Эта операция извлекает список всех веб-форм пользователя.
Получение списка всех групп, к которому принадлежит пользователь	Эта операция извлекает список всех пользователей групп.
Получение списка всех идентификаторов документов из соглашения	Эта операция извлекает идентификаторы всех документов и вспомогательных документов соглашения.
Получение списка всех идентификаторов документов из соглашения [DEPRECATED]	Это действие устарело. Вместо этого используйте список всех идентификаторов документов из соглашения . Эта операция извлекает идентификаторы всех документов и вспомогательных документов соглашения.
Получение списка всех рабочих процессов	Эта операция извлекает список всех рабочих процессов пользователя.
Получение списка всех соглашений	Эта операция извлекает список всех соглашений пользователя.
Получение списка всех соглашений (старых) [DEPRECATED]	Эта операция извлекает список всех соглашений пользователя.
Получение списка всех соглашений на основе критериев поиска	Эта операция выполняет поиск соглашений по таким критериям, как идентификатор рабочего процесса и т. д.
Получение списка всех шаблонов библиотек	Эта операция получает список всех документов, хранящихся в виде шаблонов в библиотеке подписей Adobe Acrobat пользователя.
Получение списка всех шаблонов библиотек (старых) [DEPRECATED]	Эта операция получает список всех документов, хранящихся в виде шаблонов в библиотеке подписей Adobe Acrobat пользователя.
Создание соглашения из URL-адреса документа и отправка подписи	Эта операция создает соглашение из документа, отправленного в Adobe Acrobat Sign, и отправляет его для подписи.
Создание соглашения из URL-адреса документа и отправка подписи (старая) [DEPRECATED]	Эта операция создает соглашение из документа, отправленного в Adobe Acrobat Sign, и отправляет его для подписи.
Создание соглашения из отправленного документа и отправка подписи	Эта операция создает соглашение из документа, отправленного в Adobe Acrobat Sign, и отправляет его для подписи.
Создание соглашения из отправленного документа и отправка подписи (старая) [DEPRECATED]	Эта операция создает соглашение из документа, отправленного в Adobe Acrobat Sign, и отправляет его для подписи.
Создание соглашения из рабочего процесса и отправка подписи	Эта операция создает соглашение из рабочего процесса в Adobe Acrobat Sign и отправляет его для подписи.
Создание соглашения из содержимого файла и отправка подписи	Эта операция создает соглашение из файла в Adobe Acrobat Sign и отправляет его для подписи.
Создание соглашения из шаблона библиотеки и отправка подписи	Эта операция создает соглашение из шаблона, хранящегося в библиотеке подписей Adobe Acrobat, и отправляет его для подписи.
Создание соглашения из шаблона библиотеки и отправка подписи (старая версия) [DEPRECATED]	Эта операция создает соглашение из шаблона, хранящегося в библиотеке подписей Adobe Acrobat, и отправляет его для подписи.
Создание шаблона библиотеки из URL-адреса документа	Эта операция создает шаблон в библиотеке подписей Adobe Acrobat из URL-адреса документа. Используйте этот шаблон для отправки соглашений
Создание шаблона библиотеки из URL-адреса документа (старый) [DEPRECATED]	Эта операция создает шаблон в библиотеке подписей Adobe Acrobat из URL-адреса документа. Используйте этот шаблон для отправки соглашений
Создание шаблона библиотеки из отправленного документа	Эта операция создает шаблон в библиотеке подписей Adobe Acrobat из отправленного документа. Используйте этот шаблон для отправки соглашений.
Создание шаблона библиотеки из отправленного документа (старого) [DEPRECATED]	Эта операция создает шаблон в библиотеке подписей Adobe Acrobat из отправленного документа. Используйте этот шаблон для отправки соглашений.

Отмена соглашения

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

CancelAgreement

Отменяет соглашение, определенное по соглашению, в пути.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, которое должно быть отменено.
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Состояние агрегирования	state		string	Государство, в котором должно приземлиться соглашение.
Комментарий	comment		string	Необязательный комментарий, описывающий причину отмены получателям.
Другие	notifyOthers		boolean	Хотите ли вы получать уведомления получателям.

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

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

CreateTransientDocument_V2

Эта операция отправляет документ в учетную запись Adobe Acrobat Sign и возвращает для него идентификатор документа. Этот документ временно хранится в Adobe Acrobat Sign и идентификатор документа можно использовать для дальнейших операций, таких как создание соглашения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя файла	File-Name	True	string	Имя отправленного документа с расширением
Содержимое файла	File	True	contentOnly	Поток файлов документа, который необходимо отправить
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com

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

JSON, содержащий идентификатор отправленного документа

Тело

TransientDocumentResponse

Отправка документа и получение идентификатора документа (старый) [DEPRECATED]

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

CreateTransientDocument

Эта операция отправляет документ в учетную запись Adobe Acrobat Sign и возвращает для него идентификатор документа. Этот документ временно хранится в Adobe Acrobat Sign и идентификатор документа можно использовать для дальнейших операций, таких как создание соглашения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя файла	File-Name	True	string	Имя отправленного документа с расширением
Содержимое файла	File	True	contentOnly	Поток файлов документа, который необходимо отправить

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

JSON, содержащий идентификатор отправленного документа

Тело

TransientDocumentResponse

Получение PDF-файла аудита соглашения

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

GetAgreementAuditTrail

Эта операция извлекает поток PDF-файлов аудита соглашения. Обратите внимание, что поток файлов должен храниться с именем файла, заканчивающимся расширением .pdf файла.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, сведения которого необходимы

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

Файловый поток аудита соглашения

response

AgreementAuditTrailResponse

Получение PDF-файла подписанного соглашения

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

GetCombinedDocument_V2

Эта операция извлекает поток PDF-файлов объединенного или подписанного соглашения. Обратите внимание, что поток файлов должен храниться с именем файла, заканчивающимся расширением .pdf файла.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, предоставленный действием, создающим соглашение
Присоединение вспомогательных документов?	attachSupportingDocuments		boolean	Если значение true, вложите вспомогательные документы в PDF-файл подписанного соглашения
Присоединение отчета аудита?	attachAuditReport		boolean	Если значение true, вложите отчет аудита в pdf-файл подписанного соглашения
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com

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

Поток файлов документа

response

CombinedDocumentResponse

Получение PDF-файла подписанного соглашения [DEPRECATED]

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

GetCombinedDocument

Это действие устарело. Вместо этого используйте PDF-файл подписанного соглашения .

Эта операция извлекает поток PDF-файлов объединенного или подписанного соглашения. Обратите внимание, что поток файлов должен храниться с именем файла, заканчивающимся расширением .pdf файла.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, предоставленный действием, создающим соглашение
Присоединение вспомогательных документов?	attachSupportingDocuments		boolean	Если значение true, вложите вспомогательные документы в PDF-файл подписанного соглашения
Присоединение отчета аудита?	auditReport		boolean	Если значение true, вложите отчет аудита в pdf-файл подписанного соглашения

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

Поток файлов документа

response

CombinedDocumentResponse

Получение URL-адреса подписи

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

GetSigningUrls

Эта операция извлекает URL-адрес страницы e-sign для текущего подписывателя соглашения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, предоставленный действием, создающим соглашение
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com

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

Тело

SigningUrlResponse

Получение URL-адреса представления соглашения

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

PostAgreementViews

Получает последний URL-адрес представления состояния соглашения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, сведения которого необходимы
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя представления	name	True	string	Имя запрошенного представления соглашения
Автоматический вход в систему	autoLoginUser		boolean	Если значение true, возвращенный URL-адрес автоматически регистрирует пользователя в
Нет флага Chrome	noChrome		boolean	Если значение true, внедренная страница отображается без верхнего или нижнего колонтитула.
Родительский кадр	frameParent		string	Разделенный запятыми список URL-адресов домена, в которых МОГУТ быть заданы URL-адреса

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

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

Тело

AgreementViews

Получение данных поля формы соглашения (Старое) [DEPRECATED]

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

GetAgreementFormFieldData

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, сведения которого необходимы

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

response

file

Получение данных поля формы соглашения в формате CSV

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

GetAgreementFormFieldData_V2

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, сведения которого необходимы
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com

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

Содержимое данных формы

Содержимое данных формы

binary

Получение данных поля формы соглашения в формате JSON

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

GetAgreementFormFieldData_V3

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, сведения которого необходимы
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com

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

Содержимое данных формы

Содержимое данных формы

object

Получение документа из соглашения

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

GetDocument_V2

Эта операция получает файловый поток определенного документа соглашения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, документ которого необходим
Идентификатор документа	documentId	True	string	Идентификатор документа конкретного документа соглашения
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com

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

Поток файлов документа

response

DocumentResponse

Получение документа из соглашения [DEPRECATED]

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

GetDocument

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

Эта операция получает файловый поток определенного документа соглашения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, документ которого необходим
Идентификатор документа	documentId	True	string	Идентификатор документа конкретного документа соглашения

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

Поток файлов документа

response

DocumentResponse

Получение подробных сведений о рабочем процессе

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

GetWorkflowInfo

Эта операция извлекает подробные сведения о рабочем процессе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор рабочего процесса	workflowId	True	string	Идентификатор рабочего процесса рабочего процесса, сведения которого необходимы
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя или идентификатор группы	groupId		string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"

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

JSON, содержащий подробные сведения о рабочем процессе

Тело

WorkflowDescriptionV6

Получение состояния соглашения

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

GetAgreementInfo_V2

Эта операция получает все текущие сведения о соглашении, например состояние.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, сведения которого необходимы
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com

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

Полные сведения о соглашении

Тело

AgreementInfoV6

Получение состояния соглашения [DEPRECATED]

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

GetAgreementInfo

Это действие устарело. Используйте вместо этого состояние соглашения .

Эта операция получает все текущие сведения о соглашении, например состояние.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, сведения которого необходимы

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

Полные сведения о соглашении

Тело

AgreementInfo

Получение списка всех веб-форм

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

GetAllWebForms

Эта операция извлекает список всех веб-форм пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Cursor	cursor		string	Используется для перехода по страницам. Если он не указан, возвращает первую страницу.
Размер страницы	pageSize		integer	Количество элементов на странице ответа. По умолчанию: 100; Макс: 10000
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя или идентификатор группы	groupId		string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"

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

JSON, содержащий объект массива веб-форм пользователя

Тело

userWidgetListV6

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

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

GetAllUserGroups

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Идентификатор пользователя	userId	True	string	Чтобы получить результат для авторизованного пользователя, идентификатор пользователя можно заменить "me" без кавычки.

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

JSON, содержащий список групп для данного пользователя

Тело

UserGroupsInfoV6

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

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

GetAllDocumentsofAnAgreement_V2

Эта операция извлекает идентификаторы всех документов и вспомогательных документов соглашения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, документы которого необходимы
Вспомогательные документы — тип контента	supportingDocumentContentFormat		string	Тип содержимого вспомогательных документов соглашения
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com

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

JSON, содержащий как документы, так и вспомогательные объекты массива документов

Тело

AgreementDocumentsV6

Получение списка всех идентификаторов документов из соглашения [DEPRECATED]

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

GetAllDocumentsofAnAgreement

Это действие устарело. Вместо этого используйте список всех идентификаторов документов из соглашения .

Эта операция извлекает идентификаторы всех документов и вспомогательных документов соглашения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор соглашения	agreementId	True	string	Идентификатор соглашения, документы которого необходимы
Вспомогательные документы — тип контента	supportingDocumentContentFormat		string	Тип содержимого вспомогательных документов соглашения

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

JSON, содержащий как документы, так и вспомогательные объекты массива документов

Тело

AgreementDocuments

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

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

GetAllWorkflows

Эта операция извлекает список всех рабочих процессов пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Включение черновых рабочих процессов	includeDraftWorkflows		boolean	Включение черновых рабочих процессов
Включение неактивных рабочих процессов	includeInactiveWorkflows		boolean	Включение неактивных рабочих процессов
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя или идентификатор группы	groupId		string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"

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

JSON, содержащий объект массива пользовательского рабочего процесса

Тело

userWorkflowListV6

Получение списка всех соглашений

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

GetAllAgreements_V2

Эта операция извлекает список всех соглашений пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Cursor	cursor		string	Используется для перехода по страницам. Если он не указан, возвращает первую страницу.
Размер страницы	pageSize		integer	Количество элементов на странице ответа. По умолчанию: 100; Макс: 10000
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя или идентификатор группы	groupId		string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"

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

JSON, содержащий объект массива пользовательского соглашения

Тело

userAgreementListV6

Получение списка всех соглашений (старых) [DEPRECATED]

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

GetAllAgreements

Эта операция извлекает список всех соглашений пользователя.

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

JSON, содержащий объект массива пользовательского соглашения

Тело

UserAgreements

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

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

SearchAgreements

Эта операция выполняет поиск соглашений по таким критериям, как идентификатор рабочего процесса и т. д.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя или идентификатор группы	groupId		string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"
Имя или идентификатор рабочего процесса	workflowId		string	Выберите настраиваемый рабочий процесс из списка или введите пользовательский идентификатор рабочего процесса.
Создано после	gt		string	Минимально допустимое время даты. Пример: 2020-12-31T23:59:00Z
Создано раньше	lt		string	Максимально допустимое время даты. Пример: 2023-12-31T23:59:00Z
Размер страницы	pageSize		integer	Количество элементов на странице ответа. По умолчанию: 50; Макс: 500
Начальный индекс	startIndex		integer	0 первая строка (смещение) возвращаемых результатов поиска.

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

JSON, содержащий объект массива пользовательского соглашения

Тело

userAgreementListV6

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

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

GetLibraryDocuments_V2

Эта операция получает список всех документов, хранящихся в виде шаблонов в библиотеке подписей Adobe Acrobat пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Cursor	cursor		string	Используется для перехода по страницам. Если он не указан, возвращает первую страницу.
Размер страницы	pageSize		integer	Количество элементов на странице ответа. По умолчанию: 100; Макс: 10000
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя или идентификатор группы	groupId		string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"

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

JSON, содержащий объект массива шаблонов библиотеки

Тело

LibraryDocuments

Получение списка всех шаблонов библиотек (старых) [DEPRECATED]

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

GetLibraryDocuments

Эта операция получает список всех документов, хранящихся в виде шаблонов в библиотеке подписей Adobe Acrobat пользователя.

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

JSON, содержащий объект массива шаблонов библиотеки

Тело

DocumentLibraryItems

Создание соглашения из URL-адреса документа и отправка подписи

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

CreateAgreementByUrl_V2

Эта операция создает соглашение из документа, отправленного в Adobe Acrobat Sign, и отправляет его для подписи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя соглашения	name	True	string	Имя соглашения
URL	url	True	string	Общедоступный URL-адрес для получения содержимого необработанного файла
Имя	name	True	string	Исходное имя файла системы, отправляемого документа
Тип	mimeType	True	string	Тип mime файла, на который ссылается ссылка, например application/pdf
Тип подписи	signatureType	True	string	Указывает тип подписи, запрошенный — E-signature или Written
Адрес электронной почты	email	True	string	Сообщение электронной почты участника
Authentication	authenticationMethod		string	Проверка подлинности по умолчанию: электронная почта (нет)
Пароль	password		string	Пароль, необходимый для участника
Код страны	countryCode		string	Код страны получателя, необходимый для просмотра и подписывания документа
Телефон Нет.	phone		string	Номер телефона получателя, необходимый для просмотра и подписания соглашения
Идентификатор провайдера	providerId		string	Идентификатор поставщика шлюза цифровых удостоверений.
Заказ	order	True	integer	Индекс, начиная с 1, указывающий позицию, с которой должна подписывать группа подписей.
Role	role	True	string	Текущие роли набора участников (подписыватель, утверждающий и т. д.).
Имя или идентификатор группы	groupId		string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"
Message	message		string	Необязательное сообщение получателям, запрашивающим их действие
Тип отправки	sendType		string	Тип интерфейса, используемого источником для отправки соглашения
Адрес электронной почты	email		string	Сообщение электронной почты CC соглашения
Время окончания срока действия	expirationTime		string	Время окончания срока действия соглашения. Пример: 2020-12-31T23:59:00Z
Внешний идентификатор	externalId		string	Произвольное значение из системы
Частота напоминаний	reminderFrequency		string	Как часто вы хотите отправлять напоминания?
Пароль документа	openPassword		string	Пароль, который следует использовать для шифрования PDF-файла подписанного соглашения
Имя	fieldName		string	Имя поля
Ценность	defaultValue		string	Значение по умолчанию поля
Задержка перенаправления	redirectDelay		string	Задержка (в секундах) перед тем, как пользователь перейдет на страницу успешного выполнения.
URL-адрес перенаправления	redirectUrl		string	URL-адрес перенаправления после завершения процесса подписывания, например. https://adobe.com
Начальные сообщения электронной почты	initEmails		string	Управление сообщениями уведомлений для событий запуска соглашения.
Государство	state	True	string	Государство, в котором должно приземлиться соглашение.

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

JSON, содержащий идентификатор только что созданного соглашения

Тело

AgreementCreationResponseV6

Создание соглашения из URL-адреса документа и отправка подписи (старая) [DEPRECATED]

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

CreateAgreementByUrl

Эта операция создает соглашение из документа, отправленного в Adobe Acrobat Sign, и отправляет его для подписи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя соглашения	name	True	string	Имя соглашения
URL	url	True	string	Общедоступный URL-адрес для получения документа
Имя	name	True	string	Имя указанного документа с расширением
Тип подписи	signatureType	True	string	Тип подписи, который вы хотите запросить : E-signature or Written
Электронная почта получателя	email	True	string	Электронная почта получателя
Порядок подписывания получателя	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя	recipientSetRole	True	string	Указание роли получателя
Message	message		string	Необязательное сообщение получателям, запрашивающим их действие
Дни до крайнего срока	daysUntilSigningDeadline		integer	Количество дней, оставшихся до истечения срока действия документа
Частота напоминаний	reminderFrequency		string	Как часто вы хотите отправлять напоминания?
Пароль документа	openPassword		string	Пароль, который следует использовать для шифрования PDF-файла подписанного соглашения
URL-адрес (2)	url		string	Общедоступный URL-адрес для получения документа
Имя (2)	name		string	Имя указанного документа с расширением
URL-адрес (3)	url		string	Общедоступный URL-адрес для получения документа
Имя (3)	name		string	Имя указанного документа с расширением
URL-адрес (4)	url		string	Общедоступный URL-адрес для получения документа
Имя (4)	name		string	Имя указанного документа с расширением
URL-адрес (5)	url		string	Общедоступный URL-адрес для получения документа
Имя (5)	name		string	Имя указанного документа с расширением
URL-адрес (6)	url		string	Общедоступный URL-адрес для получения документа
Имя (6)	name		string	Имя указанного документа с расширением
URL-адрес (7)	url		string	Общедоступный URL-адрес для получения документа
Имя (7)	name		string	Имя указанного документа с расширением
URL-адрес (8)	url		string	Общедоступный URL-адрес для получения документа
Имя (8)	name		string	Имя указанного документа с расширением
URL-адрес (9)	url		string	Общедоступный URL-адрес для получения документа
Имя (9)	name		string	Имя указанного документа с расширением
URL-адрес (10)	url		string	Общедоступный URL-адрес для получения документа
Имя (10)	name		string	Имя указанного документа с расширением
Электронная почта получателя (2)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (2)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (2)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (3)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (3)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (3)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (4)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (4)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (4)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (5)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (5)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (5)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (6)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (6)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (6)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (7)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (7)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (7)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (8)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (8)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (8)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (9)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (9)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (9)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (10)	email	True	string	Электронная почта получателя
Порядок подписывания получателя (10)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (10)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (11)	email	True	string	Электронная почта получателя
Заказ на подпись получателя (11)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (11)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (12)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (12)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (12)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (13)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (13)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (13)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (14)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (14)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (14)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (15)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (15)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (15)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (16)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (16)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (16)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (17)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (17)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (17)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (18)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (18)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (18)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (19)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (19)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (19)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (20)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (20)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (20)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (21)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (21)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (21)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (22)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (22)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (22)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (23)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (23)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (23)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (24)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (24)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (24)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (25)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (25)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (25)	recipientSetRole	True	string	Указание роли получателя
Имя поля формы (1)	fieldName		string	Имя поля
Значение поля формы (1)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (2)	fieldName		string	Имя поля
Значение поля формы (2)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (3)	fieldName		string	Имя поля
Значение поля формы (3)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (4)	fieldName		string	Имя поля
Значение поля формы (4)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (5)	fieldName		string	Имя поля
Значение поля формы (5)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (6)	fieldName		string	Имя поля
Значение поля формы (6)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (7)	fieldName		string	Имя поля
Значение поля формы (7)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (8)	fieldName		string	Имя поля
Значение поля формы (8)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (9)	fieldName		string	Имя поля
Значение поля формы (9)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (10)	fieldName		string	Имя поля
Значение поля формы (10)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (11)	fieldName		string	Имя поля
Значение поля формы (11)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (12)	fieldName		string	Имя поля
Значение поля формы (12)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (13)	fieldName		string	Имя поля
Значение поля формы (13)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (14)	fieldName		string	Имя поля
Значение поля формы (14)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (15)	fieldName		string	Имя поля
Значение поля формы (15)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (16)	fieldName		string	Имя поля
Значение поля формы (16)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (17)	fieldName		string	Имя поля
Значение поля формы (17)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (18)	fieldName		string	Имя поля
Значение поля формы (18)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (19)	fieldName		string	Имя поля
Значение поля формы (19)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (20)	fieldName		string	Имя поля
Значение поля формы (20)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (21)	fieldName		string	Имя поля
Значение поля формы (21)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (22)	fieldName		string	Имя поля
Значение поля формы (22)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (23)	fieldName		string	Имя поля
Значение поля формы (23)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (24)	fieldName		string	Имя поля
Значение поля формы (24)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (25)	fieldName		string	Имя поля
Значение поля формы (25)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (26)	fieldName		string	Имя поля
Значение поля формы (26)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (27)	fieldName		string	Имя поля
Значение поля формы (27)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (28)	fieldName		string	Имя поля
Значение поля формы (28)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (29)	fieldName		string	Имя поля
Значение поля формы (29)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (30)	fieldName		string	Имя поля
Значение поля формы (30)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (31)	fieldName		string	Имя поля
Значение поля формы (31)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (32)	fieldName		string	Имя поля
Значение поля формы (32)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (33)	fieldName		string	Имя поля
Значение поля формы (33)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (34)	fieldName		string	Имя поля
Значение поля формы (34)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (35)	fieldName		string	Имя поля
Значение поля формы (35)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (36)	fieldName		string	Имя поля
Значение поля формы (36)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (37)	fieldName		string	Имя поля
Значение поля формы (37)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (38)	fieldName		string	Имя поля
Значение поля формы (38)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (39)	fieldName		string	Имя поля
Значение поля формы (39)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (40)	fieldName		string	Имя поля
Значение поля формы (40)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (41)	fieldName		string	Имя поля
Значение поля формы (41)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (42)	fieldName		string	Имя поля
Значение поля формы (42)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (43)	fieldName		string	Имя поля
Значение поля формы (43)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (44)	fieldName		string	Имя поля
Значение поля формы (44)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (45)	fieldName		string	Имя поля
Значение поля формы (45)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (46)	fieldName		string	Имя поля
Значение поля формы (46)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (47)	fieldName		string	Имя поля
Значение поля формы (47)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (48)	fieldName		string	Имя поля
Значение поля формы (48)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (49)	fieldName		string	Имя поля
Значение поля формы (49)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (50)	fieldName		string	Имя поля
Значение поля формы (50)	defaultValue		string	Значение по умолчанию поля

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

JSON, содержащий идентификатор только что созданного соглашения

Тело

AgreementCreationResponse

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

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

CreateAgreementById_V2

Эта операция создает соглашение из документа, отправленного в Adobe Acrobat Sign, и отправляет его для подписи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя соглашения	name	True	string	Имя соглашения
Идентификатор	transientDocumentId	True	string	Идентификатор документа, полученный путем отправки временного документа
Тип подписи	signatureType	True	string	Тип подписи, который вы хотите запросить — электронную подпись или написанную
Адрес электронной почты	email	True	string	Сообщение электронной почты участника
Authentication	authenticationMethod		string	Проверка подлинности по умолчанию: электронная почта (нет)
Пароль	password		string	Пароль, необходимый для участника
Код страны	countryCode		string	Код страны получателя, необходимый для просмотра и подписывания документа
Телефон Нет.	phone		string	Номер телефона получателя, необходимый для просмотра и подписания соглашения
Идентификатор провайдера	providerId		string	Идентификатор поставщика шлюза цифровых удостоверений.
Заказ	order	True	integer	Индекс, начиная с 1, указывающий позицию, с которой должна подписывать группа подписей.
Role	role	True	string	Текущие роли набора участников (подписыватель, утверждающий и т. д.).
Имя или идентификатор группы	groupId		string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"
Message	message		string	Необязательное сообщение получателям, запрашивающим их действие
Тип отправки	sendType		string	Тип интерфейса, используемого источником для отправки соглашения
Адрес электронной почты	email		string	Сообщение электронной почты CC соглашения
Время окончания срока действия	expirationTime		string	Время окончания срока действия соглашения. Пример: 2020-12-31T23:59:00Z
Внешний идентификатор	externalId		string	Произвольное значение из системы
Частота напоминаний	reminderFrequency		string	Как часто вы хотите отправлять напоминания?
Пароль документа	openPassword		string	Пароль, который следует использовать для шифрования PDF-файла подписанного соглашения
Имя	fieldName		string	Имя поля
Ценность	defaultValue		string	Значение по умолчанию поля
Задержка перенаправления	redirectDelay		string	Задержка (в секундах) перед тем, как пользователь перейдет на страницу успешного выполнения.
URL-адрес перенаправления	redirectUrl		string	URL-адрес перенаправления после завершения процесса подписывания, например. https://adobe.com
Начальные сообщения электронной почты	initEmails		string	Управление сообщениями уведомлений для событий запуска соглашения.
Государство	state	True	string	Государство, в котором должно приземлиться соглашение.

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

JSON, содержащий идентификатор только что созданного соглашения

Тело

AgreementCreationResponseV6

Создание соглашения из отправленного документа и отправка подписи (старая) [DEPRECATED]

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

CreateAgreementById

Эта операция создает соглашение из документа, отправленного в Adobe Acrobat Sign, и отправляет его для подписи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя соглашения	name	True	string	Имя соглашения
Идентификатор документа	transientDocumentId	True	string	Идентификатор документа, полученный путем отправки документа
Тип подписи	signatureType	True	string	Тип подписи, который вы хотите запросить : E-signature or Written
Электронная почта получателя	email	True	string	Электронная почта получателя
Порядок подписывания получателя	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя	recipientSetRole	True	string	Указание роли получателя
Message	message		string	Необязательное сообщение получателям, запрашивающим их действие
Дни до крайнего срока	daysUntilSigningDeadline		integer	Количество дней, оставшихся до истечения срока действия документа
Частота напоминаний	reminderFrequency		string	Как часто вы хотите отправлять напоминания?
Пароль документа	openPassword		string	Пароль, который следует использовать для шифрования PDF-файла подписанного соглашения
Идентификатор документа (2)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (3)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (4)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (5)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (6)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (7)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (8)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (9)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (10)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Электронная почта получателя (2)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (2)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (2)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (3)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (3)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (3)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (4)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (4)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (4)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (5)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (5)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (5)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (6)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (6)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (6)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (7)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (7)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (7)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (8)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (8)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (8)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (9)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (9)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (9)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (10)	email	True	string	Электронная почта получателя
Порядок подписывания получателя (10)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (10)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (11)	email	True	string	Электронная почта получателя
Заказ на подпись получателя (11)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (11)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (12)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (12)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (12)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (13)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (13)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (13)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (14)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (14)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (14)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (15)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (15)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (15)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (16)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (16)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (16)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (17)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (17)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (17)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (18)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (18)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (18)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (19)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (19)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (19)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (20)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (20)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (20)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (21)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (21)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (21)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (22)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (22)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (22)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (23)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (23)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (23)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (24)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (24)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (24)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (25)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (25)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (25)	recipientSetRole	True	string	Указание роли получателя
Имя поля формы (1)	fieldName		string	Имя поля
Значение поля формы (1)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (2)	fieldName		string	Имя поля
Значение поля формы (2)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (3)	fieldName		string	Имя поля
Значение поля формы (3)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (4)	fieldName		string	Имя поля
Значение поля формы (4)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (5)	fieldName		string	Имя поля
Значение поля формы (5)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (6)	fieldName		string	Имя поля
Значение поля формы (6)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (7)	fieldName		string	Имя поля
Значение поля формы (7)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (8)	fieldName		string	Имя поля
Значение поля формы (8)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (9)	fieldName		string	Имя поля
Значение поля формы (9)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (10)	fieldName		string	Имя поля
Значение поля формы (10)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (11)	fieldName		string	Имя поля
Значение поля формы (11)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (12)	fieldName		string	Имя поля
Значение поля формы (12)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (13)	fieldName		string	Имя поля
Значение поля формы (13)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (14)	fieldName		string	Имя поля
Значение поля формы (14)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (15)	fieldName		string	Имя поля
Значение поля формы (15)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (16)	fieldName		string	Имя поля
Значение поля формы (16)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (17)	fieldName		string	Имя поля
Значение поля формы (17)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (18)	fieldName		string	Имя поля
Значение поля формы (18)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (19)	fieldName		string	Имя поля
Значение поля формы (19)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (20)	fieldName		string	Имя поля
Значение поля формы (20)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (21)	fieldName		string	Имя поля
Значение поля формы (21)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (22)	fieldName		string	Имя поля
Значение поля формы (22)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (23)	fieldName		string	Имя поля
Значение поля формы (23)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (24)	fieldName		string	Имя поля
Значение поля формы (24)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (25)	fieldName		string	Имя поля
Значение поля формы (25)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (26)	fieldName		string	Имя поля
Значение поля формы (26)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (27)	fieldName		string	Имя поля
Значение поля формы (27)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (28)	fieldName		string	Имя поля
Значение поля формы (28)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (29)	fieldName		string	Имя поля
Значение поля формы (29)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (30)	fieldName		string	Имя поля
Значение поля формы (30)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (31)	fieldName		string	Имя поля
Значение поля формы (31)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (32)	fieldName		string	Имя поля
Значение поля формы (32)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (33)	fieldName		string	Имя поля
Значение поля формы (33)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (34)	fieldName		string	Имя поля
Значение поля формы (34)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (35)	fieldName		string	Имя поля
Значение поля формы (35)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (36)	fieldName		string	Имя поля
Значение поля формы (36)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (37)	fieldName		string	Имя поля
Значение поля формы (37)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (38)	fieldName		string	Имя поля
Значение поля формы (38)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (39)	fieldName		string	Имя поля
Значение поля формы (39)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (40)	fieldName		string	Имя поля
Значение поля формы (40)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (41)	fieldName		string	Имя поля
Значение поля формы (41)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (42)	fieldName		string	Имя поля
Значение поля формы (42)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (43)	fieldName		string	Имя поля
Значение поля формы (43)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (44)	fieldName		string	Имя поля
Значение поля формы (44)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (45)	fieldName		string	Имя поля
Значение поля формы (45)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (46)	fieldName		string	Имя поля
Значение поля формы (46)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (47)	fieldName		string	Имя поля
Значение поля формы (47)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (48)	fieldName		string	Имя поля
Значение поля формы (48)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (49)	fieldName		string	Имя поля
Значение поля формы (49)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (50)	fieldName		string	Имя поля
Значение поля формы (50)	defaultValue		string	Значение по умолчанию поля

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

JSON, содержащий идентификатор только что созданного соглашения

Тело

AgreementCreationResponse

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

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

CreateAgreementFromWorkflow

Эта операция создает соглашение из рабочего процесса в Adobe Acrobat Sign и отправляет его для подписи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	x-api-user	True	string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя или идентификатор группы	groupId	True	string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"
Имя или идентификатор рабочего процесса	workflowIdParam	True	string	Выберите настраиваемый рабочий процесс из списка или введите пользовательский идентификатор рабочего процесса.
agreementWorkflowSchema	agreementWorkflowSchema	True	dynamic	Сведения о выбранном событии.

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

JSON, содержащий идентификатор только что созданного соглашения

Тело

AgreementCreationResponseV6

Создание соглашения из содержимого файла и отправка подписи

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

CreateAgreementByFileStream

Эта операция создает соглашение из файла в Adobe Acrobat Sign и отправляет его для подписи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя соглашения	name	True	string	Имя соглашения
Имя	fileName	True	string	Имя отправленного документа с расширением
Content	formData	True	byte	Поток файлов документа, который необходимо отправить
Тип подписи	signatureType	True	string	Тип подписи, который вы хотите запросить — электронную подпись или написанную
Адрес электронной почты	email	True	string	Сообщение электронной почты участника
Authentication	authenticationMethod		string	Проверка подлинности по умолчанию: электронная почта (нет)
Пароль	password		string	Пароль, необходимый для участника
Код страны	countryCode		string	Код страны получателя, необходимый для просмотра и подписывания документа
Телефон Нет.	phone		string	Номер телефона получателя, необходимый для просмотра и подписания соглашения
Идентификатор провайдера	providerId		string	Идентификатор поставщика шлюза цифровых удостоверений.
Заказ	order	True	integer	Индекс, начиная с 1, указывающий позицию, с которой должна подписывать группа подписей.
Role	role	True	string	Текущие роли набора участников (подписыватель, утверждающий и т. д.).
Имя или идентификатор группы	groupId		string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"
Message	message		string	Необязательное сообщение получателям, запрашивающим их действие
Тип отправки	sendType		string	Тип интерфейса, используемого источником для отправки соглашения
Адрес электронной почты	email		string	Сообщение электронной почты CC соглашения
Время окончания срока действия	expirationTime		string	Время окончания срока действия соглашения. Пример: 2020-12-31T23:59:00Z
Внешний идентификатор	externalId		string	Произвольное значение из системы
Частота напоминаний	reminderFrequency		string	Как часто вы хотите отправлять напоминания?
Пароль документа	openPassword		string	Пароль, который следует использовать для шифрования PDF-файла подписанного соглашения
Имя	fieldName		string	Имя поля
Ценность	defaultValue		string	Значение по умолчанию поля
Задержка перенаправления	redirectDelay		string	Задержка (в секундах) перед тем, как пользователь перейдет на страницу успешного выполнения.
URL-адрес перенаправления	redirectUrl		string	URL-адрес перенаправления после завершения процесса подписывания, например. https://adobe.com
Начальные сообщения электронной почты	initEmails		string	Управление сообщениями уведомлений для событий запуска соглашения.
Государство	state	True	string	Государство, в котором должно приземлиться соглашение.

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

JSON, содержащий идентификатор только что созданного соглашения

Тело

AgreementCreationResponseV6

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

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

CreateAgreementByTemplate_V2

Эта операция создает соглашение из шаблона, хранящегося в библиотеке подписей Adobe Acrobat, и отправляет его для подписи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя соглашения	name	True	string	Имя соглашения
Template	libraryDocumentId	True	string	Выбор документа из шаблонов, хранящихся в библиотеке
Тип подписи	signatureType	True	string	Тип подписи, который вы хотите запросить — электронную подпись или написанную
Адрес электронной почты	email	True	string	Сообщение электронной почты участника
Authentication	authenticationMethod		string	Проверка подлинности по умолчанию: электронная почта (нет)
Пароль	password		string	Пароль, необходимый для участника
Код страны	countryCode		string	Код страны получателя, необходимый для просмотра и подписывания документа
Телефон Нет.	phone		string	Номер телефона получателя, необходимый для просмотра и подписания соглашения
Идентификатор провайдера	providerId		string	Идентификатор поставщика шлюза цифровых удостоверений.
Заказ	order	True	integer	Индекс, начиная с 1, указывающий позицию, с которой должна подписывать группа подписей.
Role	role	True	string	Текущие роли набора участников (подписыватель, утверждающий и т. д.).
Имя или идентификатор группы	groupId		string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"
Message	message		string	Необязательное сообщение получателям, запрашивающим их действие
Тип отправки	sendType		string	Тип интерфейса, используемого источником для отправки соглашения
Адрес электронной почты	email		string	Сообщение электронной почты CC соглашения
Время окончания срока действия	expirationTime		string	Время окончания срока действия соглашения. Пример: 2020-12-31T23:59:00Z
Внешний идентификатор	externalId		string	Произвольное значение из системы
Частота напоминаний	reminderFrequency		string	Как часто вы хотите отправлять напоминания?
Пароль документа	openPassword		string	Пароль, который следует использовать для шифрования PDF-файла подписанного соглашения
Имя	fieldName		string	Имя поля
Ценность	defaultValue		string	Значение по умолчанию поля
Задержка перенаправления	redirectDelay		string	Задержка (в секундах) перед тем, как пользователь перейдет на страницу успешного выполнения.
URL-адрес перенаправления	redirectUrl		string	URL-адрес перенаправления после завершения процесса подписывания, например. https://adobe.com
Начальные сообщения электронной почты	initEmails		string	Управление сообщениями уведомлений для событий запуска соглашения.
Государство	state	True	string	Государство, в котором должно приземлиться соглашение.

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

JSON, содержащий идентификатор только что созданного соглашения

Тело

AgreementCreationResponseV6

Создание соглашения из шаблона библиотеки и отправка подписи (старая версия) [DEPRECATED]

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

CreateAgreementByTemplate

Эта операция создает соглашение из шаблона, хранящегося в библиотеке подписей Adobe Acrobat, и отправляет его для подписи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя соглашения	name	True	string	Имя соглашения
Шаблон библиотеки документов	libraryDocumentId	True	string	Выбор документа из шаблонов, хранящихся в библиотеке
Тип подписи	signatureType	True	string	Тип подписи, который вы хотите запросить : E-signature or Written
Электронная почта получателя	email	True	string	Электронная почта получателя
Порядок подписывания получателя	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя	recipientSetRole	True	string	Указание роли получателя
Message	message		string	Необязательное сообщение получателям, запрашивающим их действие
Дни до крайнего срока	daysUntilSigningDeadline		integer	Количество дней, оставшихся до истечения срока действия документа
Частота напоминаний	reminderFrequency		string	Как часто вы хотите отправлять напоминания?
Пароль документа	openPassword		string	Пароль, который следует использовать для шифрования PDF-файла подписанного соглашения
Шаблон библиотеки документов (2)	libraryDocumentId		string	Выбор документа из шаблонов, хранящихся в библиотеке
Шаблон библиотеки документов (3)	libraryDocumentId		string	Выбор документа из шаблонов, хранящихся в библиотеке
Шаблон библиотеки документов (4)	libraryDocumentId		string	Выбор документа из шаблонов, хранящихся в библиотеке
Шаблон библиотеки документов (5)	libraryDocumentId		string	Выбор документа из шаблонов, хранящихся в библиотеке
Шаблон библиотеки документов (6)	libraryDocumentId		string	Выбор документа из шаблонов, хранящихся в библиотеке
Шаблон библиотеки документов (7)	libraryDocumentId		string	Выбор документа из шаблонов, хранящихся в библиотеке
Шаблон библиотеки документов (8)	libraryDocumentId		string	Выбор документа из шаблонов, хранящихся в библиотеке
Шаблон библиотеки документов (9)	libraryDocumentId		string	Выбор документа из шаблонов, хранящихся в библиотеке
Шаблон библиотеки документов (10)	libraryDocumentId		string	Выбор документа из шаблонов, хранящихся в библиотеке
Электронная почта получателя (2)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (2)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (2)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (3)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (3)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (3)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (4)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (4)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (4)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (5)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (5)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (5)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (6)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (6)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (6)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (7)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (7)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (7)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (8)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (8)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (8)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (9)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (9)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (9)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (10)	email	True	string	Электронная почта получателя
Порядок подписывания получателя (10)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (10)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (11)	email	True	string	Электронная почта получателя
Заказ на подпись получателя (11)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (11)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (12)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (12)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (12)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (13)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (13)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (13)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (14)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (14)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (14)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (15)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (15)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (15)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (16)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (16)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (16)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (17)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (17)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (17)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (18)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (18)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (18)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (19)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (19)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (19)	recipientSetRole	True	string	Указание роли получателя
Адрес электронной почты получателя (20)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (20)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (20)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (21)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (21)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (21)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (22)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (22)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (22)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (23)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (23)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (23)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (24)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (24)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (24)	recipientSetRole	True	string	Указание роли получателя
Электронная почта получателя (25)	email	True	string	Электронная почта получателя
Порядок подписывания получателей (25)	signingOrder	True	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Роль получателя (25)	recipientSetRole	True	string	Указание роли получателя
Имя поля формы (1)	fieldName		string	Имя поля
Значение поля формы (1)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (2)	fieldName		string	Имя поля
Значение поля формы (2)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (3)	fieldName		string	Имя поля
Значение поля формы (3)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (4)	fieldName		string	Имя поля
Значение поля формы (4)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (5)	fieldName		string	Имя поля
Значение поля формы (5)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (6)	fieldName		string	Имя поля
Значение поля формы (6)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (7)	fieldName		string	Имя поля
Значение поля формы (7)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (8)	fieldName		string	Имя поля
Значение поля формы (8)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (9)	fieldName		string	Имя поля
Значение поля формы (9)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (10)	fieldName		string	Имя поля
Значение поля формы (10)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (11)	fieldName		string	Имя поля
Значение поля формы (11)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (12)	fieldName		string	Имя поля
Значение поля формы (12)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (13)	fieldName		string	Имя поля
Значение поля формы (13)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (14)	fieldName		string	Имя поля
Значение поля формы (14)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (15)	fieldName		string	Имя поля
Значение поля формы (15)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (16)	fieldName		string	Имя поля
Значение поля формы (16)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (17)	fieldName		string	Имя поля
Значение поля формы (17)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (18)	fieldName		string	Имя поля
Значение поля формы (18)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (19)	fieldName		string	Имя поля
Значение поля формы (19)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (20)	fieldName		string	Имя поля
Значение поля формы (20)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (21)	fieldName		string	Имя поля
Значение поля формы (21)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (22)	fieldName		string	Имя поля
Значение поля формы (22)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (23)	fieldName		string	Имя поля
Значение поля формы (23)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (24)	fieldName		string	Имя поля
Значение поля формы (24)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (25)	fieldName		string	Имя поля
Значение поля формы (25)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (26)	fieldName		string	Имя поля
Значение поля формы (26)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (27)	fieldName		string	Имя поля
Значение поля формы (27)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (28)	fieldName		string	Имя поля
Значение поля формы (28)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (29)	fieldName		string	Имя поля
Значение поля формы (29)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (30)	fieldName		string	Имя поля
Значение поля формы (30)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (31)	fieldName		string	Имя поля
Значение поля формы (31)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (32)	fieldName		string	Имя поля
Значение поля формы (32)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (33)	fieldName		string	Имя поля
Значение поля формы (33)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (34)	fieldName		string	Имя поля
Значение поля формы (34)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (35)	fieldName		string	Имя поля
Значение поля формы (35)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (36)	fieldName		string	Имя поля
Значение поля формы (36)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (37)	fieldName		string	Имя поля
Значение поля формы (37)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (38)	fieldName		string	Имя поля
Значение поля формы (38)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (39)	fieldName		string	Имя поля
Значение поля формы (39)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (40)	fieldName		string	Имя поля
Значение поля формы (40)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (41)	fieldName		string	Имя поля
Значение поля формы (41)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (42)	fieldName		string	Имя поля
Значение поля формы (42)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (43)	fieldName		string	Имя поля
Значение поля формы (43)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (44)	fieldName		string	Имя поля
Значение поля формы (44)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (45)	fieldName		string	Имя поля
Значение поля формы (45)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (46)	fieldName		string	Имя поля
Значение поля формы (46)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (47)	fieldName		string	Имя поля
Значение поля формы (47)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (48)	fieldName		string	Имя поля
Значение поля формы (48)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (49)	fieldName		string	Имя поля
Значение поля формы (49)	defaultValue		string	Значение по умолчанию поля
Имя поля формы (50)	fieldName		string	Имя поля
Значение поля формы (50)	defaultValue		string	Значение по умолчанию поля

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

JSON, содержащий идентификатор только что созданного соглашения

Тело

AgreementCreationResponse

Создание шаблона библиотеки из URL-адреса документа

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

CreateLibraryDocumentByUrl_V2

Эта операция создает шаблон в библиотеке подписей Adobe Acrobat из URL-адреса документа. Используйте этот шаблон для отправки соглашений

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя шаблона	name	True	string	Имя соглашения, используемое для идентификации шаблона
Тип шаблона	templateTypes	True	array of string	Список одного или нескольких типов шаблонов библиотеки
Режим общего доступа	sharingMode	True	string	Указывает, кто должен иметь доступ к этому документу библиотеки
URL	url	True	string	Общедоступный URL-адрес для получения содержимого необработанного файла
Имя	name	True	string	Исходное имя файла системы, отправляемого документа
Тип	mimeType	True	string	Тип mime файла, на который ссылается ссылка, например application/pdf
Состояние шаблона	state	True	string	Состояние документа библиотеки.
Имя или идентификатор группы	groupId		string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"

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

Объект JSON, описывающий шаблон библиотеки

Тело

LibraryDocumentCreationResponseV6

Создание шаблона библиотеки из URL-адреса документа (старый) [DEPRECATED]

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

CreateLibraryDocumentByUrl

Эта операция создает шаблон в библиотеке подписей Adobe Acrobat из URL-адреса документа. Используйте этот шаблон для отправки соглашений

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя шаблона	name	True	string	Имя соглашения, используемое для идентификации шаблона
Тип шаблона	libraryTemplateTypes	True	string	Список одного или нескольких типов шаблонов библиотеки
Общий доступ с помощью	librarySharingMode	True	string	Указывает, кто должен иметь доступ к этому документу библиотеки
URL	url	True	string	Общедоступный URL-адрес для получения документа
Имя	name	True	string	Имя указанного документа с расширением
URL-адрес (2)	url		string	Общедоступный URL-адрес для получения документа
Имя (2)	name		string	Имя указанного документа с расширением
URL-адрес (3)	url		string	Общедоступный URL-адрес для получения документа
Имя (3)	name		string	Имя указанного документа с расширением
URL-адрес (4)	url		string	Общедоступный URL-адрес для получения документа
Имя (4)	name		string	Имя указанного документа с расширением
URL-адрес (5)	url		string	Общедоступный URL-адрес для получения документа
Имя (5)	name		string	Имя указанного документа с расширением
URL-адрес (6)	url		string	Общедоступный URL-адрес для получения документа
Имя (6)	name		string	Имя указанного документа с расширением
URL-адрес (7)	url		string	Общедоступный URL-адрес для получения документа
Имя (7)	name		string	Имя указанного документа с расширением
URL-адрес (8)	url		string	Общедоступный URL-адрес для получения документа
Имя (8)	name		string	Имя указанного документа с расширением
URL-адрес (9)	url		string	Общедоступный URL-адрес для получения документа
Имя (9)	name		string	Имя указанного документа с расширением
URL-адрес (10)	url		string	Общедоступный URL-адрес для получения документа
Имя (10)	name		string	Имя указанного документа с расширением

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

Объект JSON, описывающий шаблон библиотеки

Тело

LibraryDocumentCreationResponse

Создание шаблона библиотеки из отправленного документа

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

CreateLibraryDocumentById_V2

Эта операция создает шаблон в библиотеке подписей Adobe Acrobat из отправленного документа. Используйте этот шаблон для отправки соглашений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	x-api-user		string	Адрес электронной почты вызывающего API в формате: электронная почта:adobesignuser@domain.com
Имя шаблона	name	True	string	Имя соглашения, используемое для идентификации шаблона
Тип шаблона	templateTypes	True	array of string	Список одного или нескольких типов шаблонов библиотеки
Режим общего доступа	sharingMode	True	string	Указывает, кто должен иметь доступ к этому документу библиотеки
Идентификатор	transientDocumentId	True	string	Идентификатор документа, полученный путем отправки временного документа
Состояние шаблона	state	True	string	Состояние документа библиотеки.
Имя или идентификатор группы	groupId		string	Идентификатор группы. Чтобы использовать это, необходимо выбрать поле "В имени"

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

Объект JSON, описывающий шаблон библиотеки

Тело

LibraryDocumentCreationResponseV6

Создание шаблона библиотеки из отправленного документа (старого) [DEPRECATED]

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

CreateLibraryDocumentById

Эта операция создает шаблон в библиотеке подписей Adobe Acrobat из отправленного документа. Используйте этот шаблон для отправки соглашений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя шаблона	name	True	string	Имя соглашения, используемое для идентификации шаблона
Тип шаблона	libraryTemplateTypes	True	string	Список одного или нескольких типов шаблонов библиотеки
Общий доступ с помощью	librarySharingMode	True	string	Указывает, кто должен иметь доступ к этому документу библиотеки
Идентификатор документа	transientDocumentId	True	string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (2)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (3)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (4)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (5)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (6)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (7)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (8)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (9)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа
Идентификатор документа (10)	transientDocumentId		string	Идентификатор документа, полученный путем отправки документа

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

Объект JSON, описывающий шаблон библиотеки

Тело

LibraryDocumentCreationResponse

Триггеры

Когда соглашение отправляется участнику	Активирует новый поток при отправке соглашения участнику.
После успешного завершения рабочего процесса соглашения	Активирует новый поток при успешном завершении рабочего процесса соглашения
При возникновении события	Активирует новый поток при возникновении события. Охватывает все события соглашения, Мега подписи и веб-формы.
При возникновении события группы	Активирует новый поток при возникновении события группы. Охватывает все события соглашения, Мега подписи и веб-формы.
При возникновении события соглашения веб-формы	Активирует новый поток при возникновении события соглашения веб-формы. Охватывает наиболее распространенные события соглашения, такие как создание, завершение и т. д.
При изменении состояния соглашения	Активирует новый поток при изменении состояния соглашения. Охватывает наиболее распространенные события соглашения, такие как создание, завершение и т. д.
При создании нового соглашения	Активирует новый поток при создании нового соглашения.

Когда соглашение отправляется участнику

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

CreateWebhookForAgreementSignatureRequestedEvent

Активирует новый поток при отправке соглашения участнику.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	name	True	string	Имя триггера
Scope	scope	True	string	Область триггера
Имя или идентификатор соглашения	resourceId		string	Укажите, только если "Область" — "Определенное соглашение". Выберите соглашение из списка или введите идентификатор соглашения.
Subscription	webhookSubscriptionEvents	True	array of string	События, для которых должен активироваться поток
Включить сведения о соглашении?	includeDetailedInfo		boolean	Следует ли отправлять подробные сведения о соглашении в уведомлении?
Включить сведения о участнике соглашения?	includeParticipantsInfo		boolean	Следует ли отправлять сведения о участнике соглашения в уведомлении?
Включить сведения о документе соглашения?	includeDocumentsInfo		boolean	Следует ли отправлять сведения о документе соглашения в уведомлении?

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

Тело

WebhookPayload

После успешного завершения рабочего процесса соглашения

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

CreateWebhookForAgreementSignedEvent

Активирует новый поток при успешном завершении рабочего процесса соглашения

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	name	True	string	Имя триггера
Scope	scope	True	string	Область триггера
Имя или идентификатор соглашения	resourceId		string	Укажите, только если "Область" — "Определенное соглашение". Выберите соглашение из списка или введите идентификатор соглашения.
Subscription	webhookSubscriptionEvents	True	array of string	События, для которых должен активироваться поток
Включить сведения о соглашении?	includeDetailedInfo		boolean	Следует ли отправлять подробные сведения о соглашении в уведомлении?
Включить сведения о участнике соглашения?	includeParticipantsInfo		boolean	Следует ли отправлять сведения о участнике соглашения в уведомлении?
Включить сведения о документе соглашения?	includeDocumentsInfo		boolean	Следует ли отправлять сведения о документе соглашения в уведомлении?
Включение сведений о подписанном соглашении?	includeSignedDocuments		boolean	Следует ли отправлять последнюю копию подписанного документа о завершении соглашения в уведомлении?

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

Тело

WebhookPayloadWithSignedDocument

При возникновении события

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

CreateWebhookGeneric

Активирует новый поток при возникновении события. Охватывает все события соглашения, Мега подписи и веб-формы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	name	True	string	Имя триггера
Scope	scope	True	string	Область триггера
Тип ресурса	resourceType		string	Укажите, только если "Область" — "Конкретный ресурс". Выберите тип ресурса, для которого должен активироваться поток.
ИД ресурса	resourceId		string	Укажите, только если "Область" — "Конкретный ресурс". Введите соглашение или мега-знак или веб-форму или идентификатор группы, для которого должен активироваться поток.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	События, для которых должен активироваться поток
Включить сведения о соглашении?	includeDetailedInfo		boolean	Следует ли отправлять подробные сведения о соглашении в уведомлении?
Включить сведения о участнике соглашения?	includeParticipantsInfo		boolean	Следует ли отправлять сведения о участнике соглашения в уведомлении?
Включить сведения о документе соглашения?	includeDocumentsInfo		boolean	Следует ли отправлять сведения о документе соглашения в уведомлении?
Включение сведений о подписанном соглашении?	includeSignedDocuments		boolean	Следует ли отправлять последнюю копию подписанного документа о завершении соглашения в уведомлении?
Включить MegaSign Info?	includeDetailedInfo		boolean	Следует ли отправлять подробные сведения о мега-подписи в уведомлении?
Включить сведения о веб-форме?	includeDetailedInfo		boolean	Следует ли отправлять подробные сведения о веб-форме в уведомлении?
Включить сведения о участнике веб-формы?	includeParticipantsInfo		boolean	Следует ли отправлять сведения о участнике веб-формы в уведомлении?
Включить сведения о документах веб-формы?	includeDocumentsInfo		boolean	Следует ли отправлять сведения о документе веб-формы в уведомлении?

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

Тело

WebhookPayloadGeneric

При возникновении события группы

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

CreateWebhookForGroupEvent

Активирует новый поток при возникновении события группы. Охватывает все события соглашения, Мега подписи и веб-формы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	name	True	string	Имя триггера
Имя или идентификатор группы	resourceId		string	Идентификатор группы
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	События, для которых должен активироваться поток
Включить сведения о соглашении?	includeDetailedInfo		boolean	Следует ли отправлять подробные сведения о соглашении в уведомлении?
Включить сведения о участнике соглашения?	includeParticipantsInfo		boolean	Следует ли отправлять сведения о участнике соглашения в уведомлении?
Включить сведения о документе соглашения?	includeDocumentsInfo		boolean	Следует ли отправлять сведения о документе соглашения в уведомлении?
Включение сведений о подписанном соглашении?	includeSignedDocuments		boolean	Следует ли отправлять последнюю копию подписанного документа о завершении соглашения в уведомлении?
Включить MegaSign Info?	includeDetailedInfo		boolean	Следует ли отправлять подробные сведения о мега-подписи в уведомлении?
Включить сведения о веб-форме?	includeDetailedInfo		boolean	Следует ли отправлять подробные сведения о веб-форме в уведомлении?
Включить сведения о участнике веб-формы?	includeParticipantsInfo		boolean	Следует ли отправлять сведения о участнике веб-формы в уведомлении?
Включить сведения о документах веб-формы?	includeDocumentsInfo		boolean	Следует ли отправлять сведения о документе веб-формы в уведомлении?

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

Тело

GroupWebhookEventPayload

При возникновении события соглашения веб-формы

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

CreateWebhookForWebFormAgreementEvent

Активирует новый поток при возникновении события соглашения веб-формы. Охватывает наиболее распространенные события соглашения, такие как создание, завершение и т. д.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	name	True	string	Имя триггера
Размер страницы веб-форм	pageSize		integer	Выберите количество веб-форм для отображения в раскрывающемся списке
Имя и идентификатор веб-формы	resourceId	True	string	Выберите веб-форму из списка или введите идентификатор веб-формы.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	События, для которых должен активироваться поток
Включить сведения о соглашении?	includeDetailedInfo		boolean	Следует ли отправлять подробные сведения о соглашении в уведомлении?
Включить сведения о участнике соглашения?	includeParticipantsInfo		boolean	Следует ли отправлять сведения о участнике соглашения в уведомлении?
Включить сведения о документе соглашения?	includeDocumentsInfo		boolean	Следует ли отправлять сведения о документе соглашения в уведомлении?
Включение сведений о подписанном соглашении?	includeSignedDocuments		boolean	Следует ли отправлять окончательную копию подписанного документа в уведомлении о завершении соглашения?

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

Тело

WebFormWebhookAgreementEventPayload

При изменении состояния соглашения

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

CreateWebhookForAgreementStatusUpdated

Активирует новый поток при изменении состояния соглашения. Охватывает наиболее распространенные события соглашения, такие как создание, завершение и т. д.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	name	True	string	Имя триггера
Scope	scope	True	string	Область триггера
Имя или идентификатор соглашения	resourceId		string	Укажите, только если "Область" — "Определенное соглашение". Выберите соглашение из списка или введите идентификатор соглашения.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	События, для которых должен активироваться поток
Включить сведения о соглашении?	includeDetailedInfo		boolean	Следует ли отправлять подробные сведения о соглашении в уведомлении?
Включить сведения о участнике соглашения?	includeParticipantsInfo		boolean	Следует ли отправлять сведения о участнике соглашения в уведомлении?
Включить сведения о документе соглашения?	includeDocumentsInfo		boolean	Следует ли отправлять сведения о документе соглашения в уведомлении?
Включение сведений о подписанном соглашении?	includeSignedDocuments		boolean	Следует ли отправлять окончательную копию подписанного документа в уведомлении о завершении соглашения?

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

Тело

WebhookPayloadWithSignedDocumentForStatusChange

При создании нового соглашения

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

CreateWebhookForAgreementCreatedEvent

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	name	True	string	Имя триггера
Scope	scope	True	string	Область триггера
Subscription	webhookSubscriptionEvents	True	array of string	События, для которых должен активироваться поток
Включить сведения о соглашении?	includeDetailedInfo		boolean	Следует ли отправлять подробные сведения о соглашении в уведомлении?
Включить сведения о участнике соглашения?	includeParticipantsInfo		boolean	Следует ли отправлять сведения о участнике соглашения в уведомлении?

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

Тело

WebhookPayloadWithoutNextParticipantSet

Определения

AgreementCreationResponse

JSON, содержащий идентификатор только что созданного соглашения

Имя	Путь	Тип	Описание
Идентификатор соглашения	agreementId	string	Уникальный идентификатор соглашения, который можно использовать для запроса состояния и скачивания подписанных документов

AgreementCreationResponseV6

JSON, содержащий идентификатор только что созданного соглашения

Имя	Путь	Тип	Описание
Идентификатор соглашения	id	string	Уникальный идентификатор соглашения, который можно использовать для запроса состояния и скачивания подписанных документов

AgreementDocuments

JSON, содержащий как документы, так и вспомогательные объекты массива документов

Имя	Путь	Тип	Описание
Documents	documents	array of Document	Список объектов, представляющих документы
Вспомогательные документы	supportingDocuments	array of SupportingDocument	Список вспомогательных документов. Это возвращается только в том случае, если в соглашении есть какой-либо вспомогательный документ

AgreementDocumentsV6

JSON, содержащий как документы, так и вспомогательные объекты массива документов

Имя	Путь	Тип	Описание
Documents	documents	array of DocumentV6	Список объектов, представляющих документы
Вспомогательные документы	supportingDocuments	array of SupportingDocumentV6	Список вспомогательных документов. Это возвращается только в том случае, если в соглашении есть какой-либо вспомогательный документ

AgreementInfo

Полные сведения о соглашении

Имя	Путь	Тип	Описание
Идентификатор соглашения	agreementId	string	Уникальный идентификатор, который можно использовать для уникальной идентификации соглашения.
Events	events	array of DocumentHistoryEvent	Упорядоченный список событий в следе аудита этого документа
Дата окончания срока действия	expiration	date	Дата, после которой соглашение больше не может быть подписано
Идентификатор последней версии	latestVersionId	string	Уникальный идентификатор, однозначно определяющий текущую версию соглашения.
Message	message	string	Сообщение, связанное с соглашением, предоставленным отправителем
Имя соглашения	name	string	Имя соглашения, указанное отправителем
Следующие наборы участников	nextParticipantSetInfos	array of NextParticipantSetInfo	Сведения о том, кто должен действовать далее для этого соглашения
Наборы участников	participantSetInfos	array of ParticipantSetInfo	Сведения обо всех наборах участников этого документа
Тип подписи	signatureType	string	Указывает тип подписи, запрошенный — E-signature или Written
Защита документов	securityOptions	string	Сведения о безопасности документа, указывающего, требуется ли пароль для просмотра и подписывания.
Состояние	status	string	Текущее состояние соглашения

AgreementInfoV6

Полные сведения о соглашении

Имя	Путь	Тип	Описание
Идентификатор соглашения	id	string	Уникальный идентификатор, который можно использовать для уникальной идентификации соглашения.
Дата создания	createdDate	date	Дата создания соглашения
Первая задержка напоминания	firstReminderDelay	integer	Целое число, указывающее задержку в часах перед отправкой первого напоминания.
Частота напоминаний	reminderFrequency	string	Как часто вы хотите отправлять напоминания?
Дата окончания срока действия	expiration	date	Дата, после которой соглашение больше не может быть подписано
Региональные настройки	locale	string	Языковой стандарт, связанный с этим соглашением, например en_US или fr_FR
Message	message	string	Сообщение, связанное с соглашением, предоставленным отправителем
Имя соглашения	name	string	Имя соглашения, указанное отправителем
Видимость документов?	documentVisibilityEnabled	boolean	Включена ли видимость документов?
Наборы участников	participantSetsInfo	array of ParticipantSetInfoV6	Сведения обо всех наборах участников этого документа
Тип подписи	signatureType	string	Указывает тип подписи, запрошенный — E-signature или Written
Параметры безопасности	securityOptions	string	Сведения о безопасности документа, указывающего, требуется ли пароль для просмотра и подписывания.
Состояние	status	string	Текущее состояние соглашения
Электронная почта отправителя	senderEmail	string	Сообщение электронной почты отправителя
Идентификатор рабочего процесса	workflowId	string	Идентификатор пользовательского рабочего процесса, который определяет путь маршрутизации соглашения.
CCs	ccs	array of CcInfo	Список одного или нескольких ЦК, которые будут скопированы в транзакции соглашения.
Идентификатор группы	groupId	string	Уникальный идентификатор группы, к которой принадлежит соглашение.

CombinedDocumentResponse

Поток файлов документа

Поток файлов документа

Содержимое файла

binary

AgreementAuditTrailResponse

Файловый поток аудита соглашения

Файловый поток аудита соглашения

Содержимое аудита соглашения

binary

DisplayUserInfo

Имя	Путь	Тип	Описание
Компания	company	string	Отображает имя компании пользователя, если она доступна
Адрес электронной почты	email	string	Отображает сообщение электронной почты пользователя
Полное имя	fullName	string	Отображает полное имя пользователя, если оно доступно.

DisplayUserSetInfo

Имя	Путь	Тип	Описание
Отображение сведений о наборе пользователей	displayUserSetMemberInfos	array of DisplayUserInfo	Отображает сведения о наборе пользователей
Отображаемое имя набора пользователей	displayUserSetName	string

Документ

Сведения о документе

Имя	Путь	Тип	Описание
Идентификатор документа	documentId	string	Уникальный идентификатор документа
Тип Mime	mimeType	string	Тип Mime документа
Имя	name	string	Имя документа
Числовые страницы	numPages	integer	Количество страниц в документе

DocumentV6

Сведения о документе

Имя	Путь	Тип	Описание
Идентификатор документа	id	string	Уникальный идентификатор документа
Тип Mime	mimeType	string	Тип Mime документа
Имя	name	string	Имя документа
Числовые страницы	numPages	integer	Количество страниц в документе

DocumentHistoryEvent

Имя	Путь	Тип	Описание
Инициатор событий	actingUserEmail	string	Адрес электронной почты пользователя, инициирующего событие
Дата события	date	date	Дата события аудита
Описание события	description	string	Описание события аудита
Электронная почта участника	participantEmail	string	Адрес электронной почты пользователя, инициирующего событие
Тип события	type	string	Тип события соглашения

DocumentLibraryItem

Имя	Путь	Тип	Описание
Идентификатор шаблона библиотеки	libraryDocumentId	string	Уникальный идентификатор документа библиотеки, используемого при отправке подписанного документа.
Типы шаблонов библиотеки	libraryTemplateTypes	array of string	Список одного или нескольких типов шаблонов библиотеки
Дата изменения	modifiedDate	date	День последнего изменения шаблона библиотеки
Имя шаблона библиотеки	name	string	Имя шаблона библиотеки
Режим общего доступа к шаблонам	scope	string	Область видимости шаблона библиотеки

DocumentLibraryItems

JSON, содержащий объект массива шаблонов библиотеки

Имя	Путь	Тип	Описание
Список шаблонов библиотек	libraryDocumentList	array of DocumentLibraryItem	Список элементов шаблона библиотеки

DocumentResponse

Поток файлов документа

Поток файлов документа

Содержимое файла

binary

LibraryDocumentCreationResponse

Объект JSON, описывающий шаблон библиотеки

Имя	Путь	Тип	Описание
Идентификатор шаблона библиотеки	libraryDocumentId	string	Уникальный идентификатор, который можно использовать для ссылки на шаблон библиотеки

NextParticipantInfo

Имя	Путь	Тип	Описание
Адрес электронной почты	email	string	Адрес электронной почты следующего участника
Имя	name	string	Имя следующего участника, если оно доступно
Ожидание с момента	waitingSince	date	Дата, с которой документ ждал, чтобы участник принял меры

NextParticipantSetInfo

Имя	Путь	Тип	Описание
Сведения о членах для следующего набора участников	nextParticipantSetMemberInfos	array of NextParticipantInfo	Сведения о членах следующего набора участников

УчастникInfo

Имя	Путь	Тип	Описание
Компания	company	string	Компания участника, если она доступна
Адрес электронной почты	email	string	Адрес электронной почты участника
Имя	name	string	Имя участника, если оно доступно
Идентификатор участника	participantId	string	Уникальный идентификатор участника
Параметры безопасности	securityOptions	array of string	Параметры безопасности, применимые к участнику
Название	title	string	Заголовок участника, если он доступен

УчастникSetInfo

Имя	Путь	Тип	Описание
Идентификатор набора участников	participantSetId	string	Уникальный идентификатор набора участников
Сведения о членах набора участников	participantSetMemberInfos	array of ParticipantInfo	Сведения о членах набора получателей
Частное сообщение	privateMessage	string	Частное сообщение для участников набора
Role	roles	array of string	Текущие роли набора участников. Набор участников может иметь одну или несколько ролей.
securityOptions	securityOptions	array of string	Параметры безопасности, применимые к участнику
Порядок подписывания	signingOrder	integer	Индекс, начиная с 1, который указывает порядок, в котором этот получатель подписывается
Состояние набора участников	status	string	Состояние участника, заданное в отношении документа

УчастникSetInfoV6

Имя	Путь	Тип	Описание
Сведения о членах набора участников	memberInfos	array of MemberInfosV6	Сведения о членах набора получателей
Заказ	order	integer	Индекс, указывающий положение, в котором должна быть подписана группа подписывания.
Role	role	string	Текущие роли набора участников (подписыватель, утверждающий и т. д.).
Имя набора участников	name	string	Имя набора участников
Набор приватных беспорядок для участников	privateMessage	string	Частное сообщение для участников набора
Видимые страницы набора участников	visiblePages	array of string	Страницы, видимые набору участников

MemberInfosV6

Имя	Путь	Тип	Описание
Адрес электронной почты	email	string	Сообщение электронной почты участника
Authentication	securityOption.authenticationMethod	string	Проверка подлинности по умолчанию: электронная почта (нет)
Пароль	securityOption.password	string	Пароль, необходимый для участника
Код страны	securityOption.phoneInfo.countryCode	string	Код страны получателя, необходимый для просмотра и подписывания документа
Телефон Нет.	securityOption.phoneInfo.phone	string	Номер телефона получателя, необходимый для просмотра и подписания соглашения
Идентификатор провайдера	securityOption.digAuthInfo.providerId	string	Идентификатор поставщика шлюза цифровых удостоверений.

ПодписываниеUrl

Имя	Путь	Тип	Описание
Электронная почта для URL-адреса для входа	email	string	Адрес электронной почты подписывателя, связанного с этим URL-адресом подписи
URL-адрес для входа	esignUrl	string	URL-адрес подписывателя, связанного с этим URL-адресом подписи

ПодписьUrlResponse

Имя	Путь	Тип	Описание
Массив URL-адресов для наборов подписывания	signingUrlSetInfos	array of SigningUrlSetInfo	Массив URL-адресов для наборов подписывания, участвующих в этом соглашении

ПодписьUrlSetInfo

Имя	Путь	Тип	Описание
— массив URL-адресов подписывания	signingUrls	array of SigningUrl	Массив URL-адресов для текущего набора подписыватель
— имя набора URL-адресов для подписи	signingUrlSetName	string	Имя текущего набора подписыватель

ПоддержкаDocument

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

Имя	Путь	Тип	Описание
Вспомогательное имя документа	displayLabel	string	Отображаемое имя вспомогательного документа
Вспомогательное имя поля документа	fieldName	string	Имя поля вспомогательного документа
Поддержка типа Mime документа	mimeType	string	Тип Mime вспомогательного документа
Поддержка страниц документов	numPages	integer	Количество страниц в вспомогательном документе
Вспомогательный идентификатор документа	supportingDocumentId	string	Уникальный идентификатор, представляющий вспомогательный документ

ПоддержкаDocumentV6

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

Имя	Путь	Тип	Описание
Вспомогательное имя документа	displayLabel	string	Отображаемое имя вспомогательного документа
Вспомогательное имя поля документа	fieldName	string	Имя поля вспомогательного документа
Поддержка типа Mime документа	mimeType	string	Тип Mime вспомогательного документа
Поддержка страниц документов	numPages	integer	Количество страниц в вспомогательном документе
Вспомогательный идентификатор документа	id	string	Уникальный идентификатор, представляющий вспомогательный документ

TransientDocumentResponse

JSON, содержащий идентификатор отправленного документа

Имя	Путь	Тип	Описание
Идентификатор документа	transientDocumentId	string	Идентификатор документа отправленного документа

UserAgreement

Имя	Путь	Тип	Описание
Идентификатор соглашения	agreementId	string	Уникальный идентификатор, который можно использовать для уникальной идентификации соглашения.
Отображение сведений о наборе пользователей	displayUserSetInfos	array of DisplayUserSetInfo	Наиболее релевантный текущий пользователь, заданный для соглашения. Обычно это следующий подписыватель, если соглашение от текущего пользователя или отправителя, если оно получено от другого пользователя.
Дата отображения	displayDate	date	Дата отображения соглашения
Esign	esign	boolean	Значение true, если это документ для подписи электронной почты
Идентификатор последней версии	latestVersionId	string	Идентификатор версии, однозначно определяющий текущую версию соглашения.
Имя	name	string	Имя соглашения
Состояние	status	string	Текущее состояние соглашения

UserAgreements

JSON, содержащий объект массива пользовательского соглашения

Имя	Путь	Тип	Описание
Список соглашений	userAgreementList	array of UserAgreement	Массив элементов соглашения

UserAgreementV6

Имя	Путь	Тип	Описание
Отображение сведений о наборе пользователей	displayParticipantSetInfos	array of DisplayUserSetInfo	Наиболее релевантный текущий пользователь, заданный для соглашения. Обычно это следующий подписыватель, если соглашение от текущего пользователя или отправителя, если оно получено от другого пользователя.
Дата отображения	displayDate	string	Дата отображения соглашения
Esign	esign	boolean	Значение true, если это документ для подписи электронной почты
Скрытый	hidden	boolean	Значение True, если соглашение скрыто для пользователя
Идентификатор группы	groupId	string	Уникальный идентификатор группы
Идентификатор последней версии	latestVersionId	string	Идентификатор версии, однозначно определяющий текущую версию соглашения.
Имя	name	string	Имя соглашения
Родительский идентификатор	parentId	string	Родительский идентификатор дочернего элемента megaSign ИЛИ исходный идентификатор экземпляра соглашения о веб-форме
Идентификатор соглашения	id	string	Уникальный идентификатор соглашения
Состояние	status	string	Текущее состояние соглашения
Тип	type	string	Тип соглашения

userAgreementListV6

JSON, содержащий объект массива пользовательского соглашения

Имя	Путь	Тип	Описание
page	page	page	Сведения о разбиении на страницы для перехода по ответу
Список соглашений	userAgreementList	array of UserAgreementV6	Массив элементов соглашения

page

Сведения о разбиении на страницы для перехода по ответу

Имя	Путь	Тип	Описание
nextCursor	nextCursor	string	Используется для перехода на следующую страницу. Если не возвращено, дальнейшие страницы отсутствуют.

WebhookPayload

Имя	Путь	Тип	Описание
Event	event	string	Событие, которое произошло в ресурсе.
Дата события	eventDate	date	Дата события. Формат будет yyy-MM-dd'T'HH:mm:ssZ. Например, например 2016-02-25T18:46:19Z представляет время UTC
Тип ресурса события	eventResourceType	string	Ресурс, на котором произошло событие.
Родительский тип соглашения	eventResourceParentType	string	Сведения о ресурсе, из которого создается соглашение. Возможные значения: веб-форма или мега-знак
Родительский идентификатор соглашения	eventResourceParentId	string	Уникальный идентификатор ресурса, из которого создается это соглашение.
Роль участника события	participantRole	string	Роль участника для события.
Идентификатор участника события	participantUserId	string	Идентификатор участника события.
Электронная почта участника события	participantUserEmail	string	Сообщение электронной почты участника для события.
Идентификатор пользователя, действующего на событиях	actingUserId	string	Идентификатор пользователя, создавшего событие.
Сообщение электронной почты пользователя о действии события	actingUserEmail	string	Сообщение электронной почты пользователя, создавшего событие.
IP-адрес пользователя, действующего на событиях	actingUserIpAddress	string	IP-адрес пользователя, создавшего событие
Идентификатор пользователя, инициирующего событие	initiatingUserId	string	Идентификатор пользователя, инициирующего событие от имени действующего пользователя.
Сообщение электронной почты пользователя, инициирующее событие	initiatingUserEmail	string	Сообщение электронной почты пользователя, инициирующего событие от имени действующего пользователя.
Уведомления применимых пользователей	webhookNotificationApplicableUsers	array of ApplicableUsers	Список пользователей, для которых применимо это уведомление
Agreement	agreement	WebhookAgreementInfo	Полная информация о соглашении

ApplicableUsers

Сведения о пользователях, для которых это уведомление применимо

Имя	Путь	Тип	Описание
Идентификатор пользователя, применимого к уведомлению	id	string	Уникальный идентификатор пользователя, для которого применимо это уведомление
Уведомление, применимое к электронной почте пользователя	email	string	Адрес электронной почты пользователя, для которого применимо это уведомление
Соответствующая роль пользователя уведомления	role	string	Роль пользователя в рабочем процессе, для которого создается это уведомление
Применимо ли пользователь полезных данных	payloadApplicable	boolean	Применимо ли данные, указанные в этом уведомлении, для этого пользователя или нет

WebhookPayloadWithoutNextParticipantSet

Имя	Путь	Тип	Описание
Event	event	string	Событие, которое произошло в ресурсе.
Дата события	eventDate	date	Дата события. Формат будет yyy-MM-dd'T'HH:mm:ssZ. Например, например 2016-02-25T18:46:19Z представляет время UTC
Тип ресурса события	eventResourceType	string	Ресурс, на котором произошло событие.
Родительский тип соглашения	eventResourceParentType	string	Сведения о ресурсе, из которого создается соглашение. Возможные значения: веб-форма или мега-знак
Родительский идентификатор соглашения	eventResourceParentId	string	Уникальный идентификатор ресурса, из которого создается это соглашение.
Идентификатор участника события	participantUserId	string	Идентификатор участника события.
Электронная почта участника события	participantUserEmail	string	Сообщение электронной почты участника для события.
Идентификатор пользователя, действующего на событиях	actingUserId	string	Идентификатор пользователя, создавшего событие.
Сообщение электронной почты пользователя о действии события	actingUserEmail	string	Сообщение электронной почты пользователя, создавшего событие.
IP-адрес пользователя, действующего на событиях	actingUserIpAddress	string	IP-адрес пользователя, создавшего событие
Идентификатор пользователя, инициирующего событие	initiatingUserId	string	Идентификатор пользователя, инициирующего событие от имени действующего пользователя
Сообщение электронной почты пользователя, инициирующее событие	initiatingUserEmail	string	Сообщение электронной почты пользователя, инициирующего событие от имени действующего пользователя.
Уведомления применимых пользователей	webhookNotificationApplicableUsers	array of ApplicableUsers	Список пользователей, для которых применимо это уведомление
Agreement	agreement	WebhookAgreementInfoWithoutNextParticipantSet	Полная информация о соглашении

WebhookPayloadWithSignedDocumentForStatusChange

Имя	Путь	Тип	Описание
Event	event	string	Событие, которое произошло в ресурсе.
Дата события	eventDate	date	Дата события. Формат будет yyy-MM-dd'T'HH:mm:ssZ. Например, например 2016-02-25T18:46:19Z представляет время UTC
Sub Event	subEvent	string	Вложенное событие, которое произошло в ресурсе.
Родительский тип соглашения	eventResourceParentType	string	Сведения о ресурсе, из которого создается соглашение. Возможные значения: веб-форма или мега-знак
Родительский идентификатор соглашения	eventResourceParentId	string	Уникальный идентификатор ресурса, из которого создается это соглашение.
Идентификатор участника события	participantUserId	string	Идентификатор участника события.
Электронная почта участника события	participantUserEmail	string	Сообщение электронной почты участника для события.
Идентификатор пользователя, действующего на событиях	actingUserId	string	Идентификатор пользователя, создавшего событие.
Сообщение электронной почты пользователя о действии события	actingUserEmail	string	Сообщение электронной почты пользователя, создавшего событие.
IP-адрес пользователя, действующего на событиях	actingUserIpAddress	string	IP-адрес пользователя, создавшего событие
Тип действия	actionType	string	Действие, для которого произошло событие.
Идентификатор пользователя, инициирующего событие	initiatingUserId	string	Идентификатор пользователя, инициирующего событие от имени действующего пользователя
Сообщение электронной почты пользователя, инициирующее событие	initiatingUserEmail	string	Сообщение электронной почты пользователя, инициирующего событие от имени действующего пользователя.
Тип ресурса события	eventResourceType	string	Ресурс, на котором произошло событие.
Роль участника события	participantRole	string	Роль участника для события.
Уведомления применимых пользователей	webhookNotificationApplicableUsers	array of ApplicableUsers	Список пользователей, для которых применимо это уведомление
Agreement	agreement	WebhookAgreementInfoWithSignedDocument	Полная информация о соглашении

WebhookPayloadWithSignedDocument

Имя	Путь	Тип	Описание
Event	event	string	Событие, которое произошло в ресурсе.
Дата события	eventDate	date	Дата события. Формат будет yyy-MM-dd'T'HH:mm:ssZ. Например, например 2016-02-25T18:46:19Z представляет время UTC
Родительский тип соглашения	eventResourceParentType	string	Сведения о ресурсе, из которого создается соглашение. Возможные значения: веб-форма или мега-знак
Родительский идентификатор соглашения	eventResourceParentId	string	Уникальный идентификатор ресурса, из которого создается это соглашение.
Тип ресурса события	eventResourceType	string	Ресурс, на котором произошло событие.
Роль участника события	participantRole	string	Роль участника для события.
Идентификатор участника события	participantUserId	string	Идентификатор участника события.
Электронная почта участника события	participantUserEmail	string	Сообщение электронной почты участника для события.
Идентификатор пользователя, действующего на событиях	actingUserId	string	Идентификатор пользователя, создавшего событие.
Сообщение электронной почты пользователя о действии события	actingUserEmail	string	Сообщение электронной почты пользователя, создавшего событие.
IP-адрес пользователя, действующего на событиях	actingUserIpAddress	string	IP-адрес пользователя, создавшего событие
Идентификатор пользователя, инициирующего событие	initiatingUserId	string	Идентификатор пользователя, инициирующего событие от имени действующего пользователя
Сообщение электронной почты пользователя, инициирующее событие	initiatingUserEmail	string	Сообщение электронной почты пользователя, инициирующего событие от имени действующего пользователя.
Уведомления применимых пользователей	webhookNotificationApplicableUsers	array of ApplicableUsers	Список пользователей, для которых применимо это уведомление
Agreement	agreement	WebhookAgreementInfoWithSignedDocument	Полная информация о соглашении

WebhookPayloadGeneric

Имя	Путь	Тип	Описание
Event	event	string	Событие, которое произошло в ресурсе.
Дата события	eventDate	date	Дата события. Формат будет yyy-MM-dd'T'HH:mm:ssZ. Например, например 2016-02-25T18:46:19Z представляет время UTC
Sub Event	subEvent	string	Вложенное событие, которое произошло в ресурсе.
Родительский тип соглашения	eventResourceParentType	string	Сведения о ресурсе, из которого создается соглашение. Возможные значения: веб-форма или мега-знак
Родительский идентификатор соглашения	eventResourceParentId	string	Уникальный идентификатор ресурса, из которого создается это соглашение.
Тип ресурса события	eventResourceType	string	Ресурс, на котором произошло событие.
Роль участника события	participantRole	string	Роль участника для события.
Идентификатор участника события	participantUserId	string	Идентификатор участника события.
Электронная почта участника события	participantUserEmail	string	Сообщение электронной почты участника для события.
Идентификатор пользователя, действующего на событиях	actingUserId	string	Идентификатор пользователя, создавшего событие.
Сообщение электронной почты пользователя о действии события	actingUserEmail	string	Сообщение электронной почты пользователя, создавшего событие.
Идентификатор пользователя, инициирующего событие	initiatingUserId	string	Идентификатор пользователя, инициирующего событие от имени действующего пользователя
Сообщение электронной почты пользователя, инициирующее событие	initiatingUserEmail	string	Сообщение электронной почты пользователя, инициирующего событие от имени действующего пользователя.
Тип действия	actionType	string	Действие, для которого произошло событие.
IP-адрес пользователя, действующего на событиях	actingUserIpAddress	string	IP-адрес пользователя, создавшего событие
Уведомления применимых пользователей	webhookNotificationApplicableUsers	array of ApplicableUsers	Список пользователей, для которых применимо это уведомление
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	Полная информация о соглашении
Знак Мега	megaSign	WebhookMegaSignInfo	Полные сведения о мега-знаке
Веб-форма	widget	WebhookWidgetInfo	Полные сведения о веб-форме

WebFormWebhookAgreementEventPayload

Имя	Путь	Тип	Описание
Event	event	string	Событие соглашения, которое произошло в веб-форме.
Дата события	eventDate	date	Дата события. Формат будет yyy-MM-dd'T'HH:mm:ssZ. Например, например 2016-02-25T18:46:19Z представляет время UTC
Sub Event	subEvent	string	Вложенное событие, которое произошло в веб-форме.
Родительский тип соглашения — веб-форма	eventResourceParentType	string	Значение, указывающее, что соглашение создается из веб-формы.
Идентификатор веб-формы	eventResourceParentId	string	Уникальный идентификатор веб-формы, из которой создается это соглашение.
Тип ресурса события — соглашение	eventResourceType	string	Ресурс, на котором произошло событие.
Роль участника события	participantRole	string	Роль участника для события.
Идентификатор участника события	participantUserId	string	Идентификатор участника события.
Электронная почта участника события	participantUserEmail	string	Сообщение электронной почты участника для события.
Идентификатор пользователя, действующего на событиях	actingUserId	string	Идентификатор пользователя, создавшего событие.
Сообщение электронной почты пользователя о действии события	actingUserEmail	string	Сообщение электронной почты пользователя, создавшего событие.
Идентификатор пользователя, инициирующего событие	initiatingUserId	string	Идентификатор пользователя, инициирующего событие от имени действующего пользователя
Сообщение электронной почты пользователя, инициирующее событие	initiatingUserEmail	string	Сообщение электронной почты пользователя, инициирующего событие от имени действующего пользователя.
Тип действия	actionType	string	Действие, для которого произошло событие.
IP-адрес пользователя, действующего на событиях	actingUserIpAddress	string	IP-адрес пользователя, создавшего событие
Уведомления применимых пользователей	webhookNotificationApplicableUsers	array of ApplicableUsers	Список пользователей, для которых применимо это уведомление
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	Полная информация о соглашении

GroupWebhookEventPayload

Имя	Путь	Тип	Описание
Event	event	string	Событие, которое произошло для группы.
Дата события	eventDate	date	Дата события. Формат будет yyy-MM-dd'T'HH:mm:ssZ. Например, например 2016-02-25T18:46:19Z представляет время UTC
Sub Event	subEvent	string	Вложенное событие, которое произошло для группы.
Родительский тип соглашения — веб-форма	eventResourceParentType	string	Сведения о группе, из которой создается соглашение.
Идентификатор веб-формы	eventResourceParentId	string	Уникальный идентификатор группы, из которой создается это соглашение.
Тип ресурса события — соглашение	eventResourceType	string	Группа, для которой произошло событие.
Роль участника события	participantRole	string	Роль участника для события.
Идентификатор участника события	participantUserId	string	Идентификатор участника события.
Электронная почта участника события	participantUserEmail	string	Сообщение электронной почты участника для события.
Идентификатор пользователя, действующего на событиях	actingUserId	string	Идентификатор пользователя, создавшего событие.
Сообщение электронной почты пользователя о действии события	actingUserEmail	string	Сообщение электронной почты пользователя, создавшего событие.
Идентификатор пользователя, инициирующего событие	initiatingUserId	string	Идентификатор пользователя, инициирующего событие от имени действующего пользователя
Сообщение электронной почты пользователя, инициирующее событие	initiatingUserEmail	string	Сообщение электронной почты пользователя, инициирующего событие от имени действующего пользователя.
Тип действия	actionType	string	Действие, для которого произошло событие.
IP-адрес пользователя, действующего на событиях	actingUserIpAddress	string	IP-адрес пользователя, создавшего событие
Уведомления применимых пользователей	webhookNotificationApplicableUsers	array of ApplicableUsers	Список пользователей, для которых применимо это уведомление
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	Полная информация о соглашении
Знак Мега	megaSign	WebhookMegaSignInfo	Полные сведения о мега-знаке
Веб-форма	widget	WebhookWidgetInfo	Полные сведения о веб-форме

WebhookAgreementInfo

Полная информация о соглашении

Имя	Путь	Тип	Описание
Идентификатор	id	string	Уникальный идентификатор соглашения
Имя	name	string	Имя соглашения
Тип подписи	signatureType	string	Указывает тип подписи, запрошенный — E-signature или Written
Состояние	status	string	Текущее состояние соглашения
CCs	ccs	array of CcInfo	Список одного или нескольких ЦК, которые будут скопированы в транзакции соглашения.
Дата создания	createdDate	date	Дата создания соглашения
Время окончания срока действия	expirationTime	string	Время после истечения срока действия соглашения и его необходимо подписать до него.
Внешний идентификатор	externalId.id	string	Произвольное значение из системы, которое можно указать во время отправки, а затем позже возвращено или запрошено.
Внешняя группа	externalId.group	string	Произвольное значение из системы, которое можно указать во время отправки, а затем позже возвращено или запрошено.
Первая задержка напоминания	firstReminderDelay	integer	Целое число, указывающее задержку в часах перед отправкой первого напоминания.
Региональные настройки	locale	string	Языковой стандарт, связанный с этим соглашением
Message	message	string	Необязательное сообщение участникам, описывающее, что отправляется или почему их подпись требуется
Частота напоминаний	reminderFrequency	string	Необязательный параметр, который задает частоту отправки напоминаний участникам. Если он не указан, будет использоваться частота по умолчанию для учетной записи.
Электронная почта отправителя	senderEmail	string	Электронная почта отправителя соглашения
Включено хранилище?	vaultingInfo.enabled	boolean	Для учетных записей, настроенных для хранилища документов и параметра включения для каждого соглашения, это определяет, должен ли документ быть хранилищем.
Видимость документов?	documentVisibilityEnabled	boolean	Включена видимость документов
Идентификатор рабочего процесса	workflowId	string	Идентификатор пользовательского рабочего процесса, который определяет путь маршрутизации соглашения.
URL-адрес перенаправления подписей	postSignOption.redirectUrl	string	Общедоступный URL-адрес, на который пользователь будет отправлен после успешного завершения процесса подписи
Наборы участников	participantSetsInfo.participantSets	array of WebhookParticipantSets	Участник задает сведения
Следующие наборы участников	participantSetsInfo.nextParticipantSets	array of WebhookParticipantSets	Следующий участник задает сведения
Documents	documentsInfo.documents	array of WebhookDocument	Список объектов, представляющих документы
Вспомогательные документы	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Список вспомогательных документов

WebhookAgreementInfoWithoutNextParticipantSet

Полная информация о соглашении

Имя	Путь	Тип	Описание
Идентификатор	id	string	Уникальный идентификатор соглашения
Имя	name	string	Имя соглашения
Тип подписи	signatureType	string	Указывает тип подписи, запрошенный — E-signature или Written
Состояние	status	string	Текущее состояние соглашения
CCs	ccs	array of CcInfo	Список одного или нескольких ЦК, которые будут скопированы в транзакции соглашения.
Дата создания	createdDate	date	Дата создания соглашения
Видимость документов?	documentVisibilityEnabled	boolean	Включена видимость документов
Время окончания срока действия	expirationTime	string	Время после истечения срока действия соглашения и его необходимо подписать до него.
Внешний идентификатор	externalId.id	string	Произвольное значение из системы, которое можно указать во время отправки, а затем позже возвращено или запрошено.
Внешняя группа	externalId.group	string	Произвольное значение из системы, которое можно указать во время отправки, а затем позже возвращено или запрошено.
Первая задержка напоминания	firstReminderDelay	integer	Целое число, указывающее задержку в часах перед отправкой первого напоминания.
Региональные настройки	locale	string	Языковой стандарт, связанный с этим соглашением
Message	message	string	Необязательное сообщение участникам, описывающее, что отправляется или почему их подпись требуется
Частота напоминаний	reminderFrequency	string	Необязательный параметр, который задает частоту отправки напоминаний участникам. Если он не указан, будет использоваться частота по умолчанию для учетной записи.
Электронная почта отправителя	senderEmail	string	Электронная почта отправителя соглашения
Включено хранилище?	vaultingInfo.enabled	boolean	Для учетных записей, настроенных для хранилища документов и параметра включения для каждого соглашения, это определяет, должен ли документ быть хранилищем.
URL-адрес перенаправления подписей	postSignOption.redirectUrl	string	Общедоступный URL-адрес, на который пользователь будет отправлен после успешного завершения процесса подписи
Идентификатор рабочего процесса	workflowId	string	Идентификатор пользовательского рабочего процесса, который определяет путь маршрутизации соглашения.
Наборы участников	participantSetsInfo.participantSets	array of WebhookParticipantSets	Участник задает сведения

WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Полная информация о соглашении

Имя	Путь	Тип	Описание
Идентификатор	id	string	Уникальный идентификатор соглашения
Имя	name	string	Имя соглашения
Тип подписи	signatureType	string	Указывает тип подписи, запрошенный — E-signature или Written
Состояние	status	string	Текущее состояние соглашения
CCs	ccs	array of CcInfo	Список одного или нескольких ЦК, которые будут скопированы в транзакции соглашения.
Дата создания	createdDate	date	Дата создания соглашения
Время окончания срока действия	expirationTime	string	Время после истечения срока действия соглашения и его необходимо подписать до него.
Внешний идентификатор	externalId.id	string	Произвольное значение из системы, которое можно указать во время отправки, а затем позже возвращено или запрошено.
Внешняя группа	externalId.group	string	Произвольное значение из системы, которое можно указать во время отправки, а затем позже возвращено или запрошено.
Первая задержка напоминания	firstReminderDelay	integer	Целое число, указывающее задержку в часах перед отправкой первого напоминания.
Региональные настройки	locale	string	Языковой стандарт, связанный с этим соглашением
Message	message	string	Необязательное сообщение участникам, описывающее, что отправляется или почему их подпись требуется
Частота напоминаний	reminderFrequency	string	Необязательный параметр, который задает частоту отправки напоминаний участникам. Если он не указан, будет использоваться частота по умолчанию для учетной записи.
URL-адрес перенаправления подписей	postSignOption.redirectUrl	string	Общедоступный URL-адрес, на который пользователь будет отправлен после успешного завершения процесса подписи
Идентификатор рабочего процесса	workflowId	string	Идентификатор пользовательского рабочего процесса, который определяет путь маршрутизации соглашения.
Электронная почта отправителя	senderEmail	string	Электронная почта отправителя соглашения
Видимость документов?	documentVisibilityEnabled	boolean	Включена видимость документов
Включено хранилище?	vaultingInfo.enabled	boolean	Для учетных записей, настроенных для хранилища документов и параметра включения для каждого соглашения, это определяет, должен ли документ быть хранилищем.
Наборы участников	participantSetsInfo.participantSets	array of WebhookParticipantSets	Участник задает сведения
Следующие наборы участников	participantSetsInfo.nextParticipantSets	array of WebhookParticipantSets	Следующий участник задает сведения
Documents	documentsInfo.documents	array of WebhookDocument	Список объектов, представляющих документы
Вспомогательные документы	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Список вспомогательных документов Возвращается только в том случае, если в соглашении есть какой-либо вспомогательный документ.
Подписанные сведения о документе	signedDocumentInfo.document	string	Строка в кодировке Base64 подписанного документа

WebhookAgreementInfoWithSignedDocument

Полная информация о соглашении

Имя	Путь	Тип	Описание
Идентификатор	id	string	Уникальный идентификатор соглашения
Имя	name	string	Имя соглашения
Тип подписи	signatureType	string	Указывает тип подписи, запрошенный — E-signature или Written
Состояние	status	string	Текущее состояние соглашения
CCs	ccs	array of CcInfo	Список одного или нескольких ЦК, которые будут скопированы в транзакции соглашения
Дата создания	createdDate	date	Дата создания соглашения
Видимость документов?	documentVisibilityEnabled	boolean	Включена видимость документов
Время окончания срока действия	expirationTime	string	Время после истечения срока действия соглашения и его необходимо подписать до него.
Внешний идентификатор	externalId.id	string	Произвольное значение из системы, которое можно указать во время отправки, а затем позже возвращено или запрошено.
Внешняя группа	externalId.group	string	Произвольное значение из системы, которое можно указать во время отправки, а затем позже возвращено или запрошено.
Первая задержка напоминания	firstReminderDelay	integer	Целое число, указывающее задержку в часах перед отправкой первого напоминания.
Региональные настройки	locale	string	Языковой стандарт, связанный с этим соглашением
Message	message	string	Необязательное сообщение участникам, описывающее, что отправляется или почему их подпись требуется
Частота напоминаний	reminderFrequency	string	Необязательный параметр, который задает частоту отправки напоминаний участникам. Если он не указан, будет использоваться частота по умолчанию для учетной записи.
Электронная почта отправителя	senderEmail	string	Электронная почта отправителя соглашения
Включено хранилище?	vaultingInfo.enabled	boolean	Для учетных записей, настроенных для хранилища документов и параметра включения для каждого соглашения, это определяет, должен ли документ быть хранилищем.
URL-адрес перенаправления подписей	postSignOption.redirectUrl	string	Общедоступный URL-адрес, на который пользователь будет отправлен после успешного завершения процесса подписи
Идентификатор рабочего процесса	workflowId	string	Идентификатор пользовательского рабочего процесса, который определяет путь маршрутизации соглашения.
Наборы участников	participantSetsInfo.participantSets	array of WebhookParticipantSets	Участник задает сведения
Documents	documentsInfo.documents	array of WebhookDocument	Список объектов, представляющих документы
Вспомогательные документы	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Список вспомогательных документов Возвращается только в том случае, если в соглашении есть какой-либо вспомогательный документ.
Подписанные сведения о документе	signedDocumentInfo.document	string	Строка в кодировке Base64 подписанного документа

WebhookMegaSignInfo

Полные сведения о мега-знаке

Имя	Путь	Тип	Описание
Идентификатор	id	string	Уникальный идентификатор меганазначения
Имя	name	string	Имя меганазначения
Состояние	status	string	Состояние меганазначения
CCs	ccs	array of MegaSignCcInfo	Список одного или нескольких адресов электронной почты, которые вы хотите скопировать на этот мегаsign.
Внешний идентификатор	externalId.id	string	Произвольное значение из системы, которое можно указать во время отправки, а затем позже возвращено или запрошено.
Первая задержка напоминания	firstReminderDelay	integer	Целое число, указывающее задержку в часах перед отправкой первого напоминания.
Региональные настройки	locale	string	Языковой стандарт, связанный с этим соглашением
Message	message	string	Необязательное сообщение участникам, описывающее, что отправляется или почему их подпись требуется
URL-адрес перенаправления подписей	postSignOption.redirectUrl	string	Общедоступный URL-адрес, на который пользователь будет отправлен после успешного завершения процесса подписи
Электронная почта отправителя	senderEmail	string	Электронная почта создателя megasign
Тип подписи	signatureType	string	Указывает тип подписи, запрошенный — E-signature или Written
Включено хранилище?	vaultingInfo.enabled	boolean	Для учетных записей, настроенных для хранилища документов и параметра включения для каждого соглашения, это определяет, должен ли документ быть хранилищем.
Сведения о файлах дочерних соглашений	childAgreementsInfo.fileInfo	MegaSignChildAgreementsFileInfo	Сведения о файле, содержащие сведения о соглашении о дочернем соглашении megaSign.

WebhookWidgetInfo

Полные сведения о веб-форме

Имя	Путь	Тип	Описание
Идентификатор	id	string	Уникальный идентификатор веб-формы
Имя	name	string	Имя веб-формы
Состояние	status	string	Состояние веб-формы
Сведения о сбое проверки подлинности	authFailureInfo	AuthFailureWidgetRedirectionInfo	URL-адрес и связанные свойства страницы ошибок, которые подписывает веб-форма, будут приняты после сбоя проверки подлинности.
CCs	ccs	array of WidgetCcInfo	Список одного или нескольких адресов электронной почты, которые требуется скопировать в этой веб-форме.
Дата создания	createdDate	date	Дата создания веб-формы
Сведения о завершении	completionInfo	WidgetCompletionRedirectionInfo	URL-адрес и связанные свойства для страницы успешного выполнения веб-формы будут приняты после выполнения требуемого действия в веб-форме.
Создатель электронной почты	creatorEmail	string	Электронная почта создателя веб-формы
Включено хранилище?	vaultingInfo.enabled	boolean	Для учетных записей, настроенных для хранилища документов и параметра включения для каждого соглашения, это определяет, должен ли документ быть хранилищем.
Дополнительные сведения о наборах участников	participantSetsInfo.additionalParticipantSets	array of WidgetParticipantSetInfo	Список всех участников веб-формы, кроме подписи веб-формы
Роль первого набора участников	participantSetsInfo.widgetParticipantSet.role	string	Роль, предполагаемая всеми участниками набора (подписыватель, утверждающий и т. д.)
Порядок набора первых участников	participantSetsInfo.widgetParticipantSet.order	integer	Индекс, указывающий последовательную группу подписывания (указанную для гибридной маршрутизации)
Documents	documentsInfo.documents	array of WidgetWebhookDocument	Список объектов, представляющих документы

AuthFailureWidgetRedirectionInfo

URL-адрес и связанные свойства страницы ошибок, которые подписывает веб-форма, будут приняты после сбоя проверки подлинности.

Имя	Путь	Тип	Описание
Задержка перенаправления отказа проверки подлинности	delay	integer	Задержка (в секундах) перед тем, как пользователь перейдет на результирующий страницу
Дефрейм перенаправления сбоя проверки подлинности	deframe	boolean	Если дефрейм имеет значение false, результирующая страница будет отображаться внутри кадра веб-формы.
Url-адрес перенаправления сбоя проверки подлинности	url	string	Общедоступный URL-адрес, на который пользователь будет отправлен после успешного завершения веб-формы.

WidgetCompletionRedirectionInfo

URL-адрес и связанные свойства для страницы успешного выполнения веб-формы будут приняты после выполнения требуемого действия в веб-форме.

Имя	Путь	Тип	Описание
Задержка перенаправления завершения	delay	integer	Задержка (в секундах) перед тем, как пользователь перейдет на результирующий страницу
Дефрейм перенаправления завершения	deframe	boolean	Если дефрейм имеет значение false, результирующая страница будет отображаться внутри кадра веб-формы.
URL-адрес перенаправления завершения	url	string	Общедоступный URL-адрес, на который пользователь будет отправлен после успешного завершения веб-формы.

WebhookParticipantSets

Имя	Путь	Тип	Описание
Сведения о членах	memberInfos	array of MemberInfos	Сведения о участниках
Заказ	order	integer	Индекс, указывающий положение, в котором должна быть подписана группа подписывания.
Role	role	string	Роль, предполагаемая всеми участниками набора (подписыватель, утверждающий и т. д.)
Состояние	status	string	Текущее состояние соглашения с точки зрения пользователя
Идентификатор	id	string	Идентификатор набора участников
Имя	name	string	Имя набора участников
Частное сообщение	privateMessage	string	Частное сообщение для участников набора

MegaSignChildAgreementsFileInfo

Сведения о файле, содержащие сведения о соглашении о дочернем соглашении megaSign.

Имя	Путь	Тип	Описание
Идентификатор файла дочерних соглашений	childAgreementsInfoFileId	string	Идентификатор файла, содержащего сведения о существующем дочернем объектеAgreementsInfo мегаSign.

WidgetWebhookDocument

Сведения о документе веб-формы

Имя	Путь	Тип	Описание
Идентификатор	id	string	Уникальный идентификатор документа
Имя	name	string	Имя документа

WebhookDocument

Сведения о документе соглашения

Имя	Путь	Тип	Описание
Идентификатор	id	string	Уникальный идентификатор документа
Имя	name	string	Имя документа

WebhookSupportingDocument

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

Имя	Путь	Тип	Описание
Имя	displayLabel	string	Отображаемое имя вспомогательного документа
Имя поля	fieldName	string	Имя поля вспомогательного документа
Идентификатор	id	string	Уникальный идентификатор, представляющий вспомогательный документ

WidgetCcInfo

Сведения о cc веб-формы

Имя	Путь	Тип	Описание
Адрес электронной почты	email	string	Электронная почта участника CC веб-формы

MegaSignCcInfo

Сведения о CC мега-знака

Имя	Путь	Тип	Описание
Адрес электронной почты	email	string	Электронная почта участника CC меганазначения

CcInfo

Сведения о CC соглашения

Имя	Путь	Тип	Описание
Адрес электронной почты	email	string	Сообщение электронной почты CC соглашения
Этикетка	label	string	Метка списка CC, возвращаемого в описании рабочего процесса
Видимые страницы	visiblePages	array of string	Страницы, видимые для CC

WidgetParticipantSetInfo

Имя	Путь	Тип	Описание
Role	role	string	Роль, предполагаемая всеми участниками набора (подписыватель, утверждающий и т. д.)
Идентификатор	id	string	Уникальный идентификатор набора участников
Сведения о членах	memberInfos	array of MemberInfos	Сведения о участниках
Заказ	order	integer	Индекс, указывающий последовательную группу подписывания (указанную для гибридной маршрутизации)

MemberInfos

Имя	Путь	Тип	Описание
Идентификатор	id	string	Уникальный идентификатор участника
Адрес электронной почты	email	string	Сообщение электронной почты участника
Компания	company	string	Компания участника
Имя	name	string	Имя участника
Частное сообщение	privateMessage	string	Частное сообщение участника
Состояние	status	string	Состояние участника

LibraryDocumentCreationResponseV6

Объект JSON, описывающий шаблон библиотеки

Имя	Путь	Тип	Описание
Идентификатор шаблона библиотеки	id	string	Уникальный идентификатор, который можно использовать для ссылки на шаблон библиотеки

LibraryDocument

Имя	Путь	Тип	Описание
Идентификатор шаблона библиотеки	id	string	Уникальный идентификатор, используемый для ссылки на шаблон библиотеки
Скрытый	hidden	boolean	Значение True, если документ библиотеки скрыт
Тип шаблона	templateTypes	array of string	Список одного или нескольких типов шаблонов библиотеки
Дата изменения	modifiedDate	date	День последнего изменения шаблона библиотеки
Имя шаблона библиотеки	name	string	Имя шаблона библиотеки
Режим общего доступа к шаблонам	sharingMode	string	Область видимости шаблона библиотеки
Создатель электронной почты	creatorEmail	string	Адрес электронной почты создателя документа библиотеки.
Идентификатор группы	groupId	string	Уникальный идентификатор группы, к которой принадлежит шаблон библиотеки.
Состояние	status	string	Состояние документа библиотеки

LibraryDocuments

JSON, содержащий объект массива шаблонов библиотеки

Имя	Путь	Тип	Описание
page	page	page	Сведения о разбиении на страницы для перехода по ответу
Список шаблонов библиотек	libraryDocumentList	array of LibraryDocument	Список элементов шаблона библиотеки

UserWidgetV6

Имя	Путь	Тип	Описание
Идентификатор веб-формы	id	string	Уникальный идентификатор веб-формы
Дата изменения	modifiedDate	string	Дата последнего изменения веб-формы
Скрытый	hidden	boolean	Значение True, если соглашение скрыто для пользователя
Идентификатор группы	groupId	string	Уникальный идентификатор группы
Имя	name	string	Имя веб-формы
Состояние	status	string	Состояние веб-формы
URL-адрес	url	string	Размещенный URL-адрес веб-формы
Javascript	javascript	string	Внедренный код javascript веб-формы

userWidgetListV6

JSON, содержащий объект массива веб-форм пользователя

Имя	Путь	Тип	Описание
page	page	page	Сведения о разбиении на страницы для перехода по ответу
Список веб-форм	userWidgetList	array of UserWidgetV6	Массив элементов веб-формы

UserWorkflowV6

Имя	Путь	Тип	Описание
Идентификатор рабочего процесса	id	string	Уникальный идентификатор рабочего процесса
Description	description	string	Описание, предоставленное для этого рабочего процесса во время его создания
Дата создания	created	string	Дата создания рабочего процесса. Формат будет yyy-MM-dd'T'HH:mm:ssZ
Дата изменения	modified	string	Дата изменения рабочего процесса. Формат будет yyy-MM-dd'T'HH:mm:ssZ
Имя	name	string	Имя рабочего процесса
Отображаемое имя	displayName	string	Отображаемое имя рабочего процесса
Состояние	status	string	Состояние рабочего процесса
Scope	scope	string	Область рабочего процесса
Идентификатор инициатора	originatorId	string	Исходный источник рабочего процесса
Идентификатор области	scopeId	string	Идентификатор области. В настоящее время применимо только для области GROUP, и значение будет groupId.

userWorkflowListV6

JSON, содержащий объект массива пользовательского рабочего процесса

Имя	Путь	Тип	Описание
Список рабочих процессов	userWorkflowList	array of UserWorkflowV6	Массив элементов рабочего процесса

WorkflowDefaultParamsV6

JSON, содержащий объект params рабочего процесса по умолчанию

Имя	Путь	Тип	Описание
Значение по умолчанию	defaultValue	string	Значение по умолчанию поля, если входные данные для этого поля не указаны, и это поле является обязательным.
Возможно изменение	editable	boolean	Можно ли изменить текущее поле. Если изменяемый атрибут для этого поля имеет значение false, то это поле не должно быть указано в запросе на создание соглашения и значение по умолчанию этого поля будет использоваться при создании соглашения.
Обязательно	required	boolean	Является ли это поле обязательным или необязательным
Видимо	visible	boolean	Отображается ли текущее поле. Если видимый атрибут для этого поля имеет значение false, то это поле не должно отображаться в пользовательском интерфейсе создания соглашения с помощью этого рабочего процесса для пользователя

CCsListInfoDescriptionV6

JSON, содержащий подробные сведения о рабочем процессе

Имя	Путь	Тип	Описание
Значения по умолчанию	defaultValues	array of string	Массив сообщений электронной почты по умолчанию, который будет использоваться, если входные данные не указаны для этого элемента списка
Возможно изменение	editable	boolean	Можно ли изменить текущее поле. Если изменяемый атрибут для этого поля имеет значение false, то это поле не должно быть указано в запросе на создание соглашения и значение по умолчанию этого поля будет использоваться при создании соглашения.
Этикетка	label	string	Отображаемый текст для пользователя рабочего процесса, который можно использовать для текущего списка CC
Максимальное количество записей CC	maxListCount	integer	Максимальное число записей, разрешенных в текущем списке CC
Минимальное количество записей CC	minListCount	integer	Минимальное количество записей, разрешенных в текущем списке CC
Имя списка CC	name	string	Имя текущего списка CC
Обязательно	required	boolean	Является ли это поле обязательным или необязательным
Видимо	visible	boolean	Отображается ли текущее поле. Если видимый атрибут для этого поля имеет значение false, то это поле не должно отображаться на странице создания соглашения с помощью этого рабочего процесса.

ExpirationFieldInfoDescriptionV6

JSON, содержащий сведения об истечении срока действия

Имя	Путь	Тип	Описание
Значение по умолчанию	defaultValue	string	Значение по умолчанию поля, если входные данные для этого поля не указаны, и это поле является обязательным.
Возможно изменение	editable	boolean	Можно ли изменить текущее поле. Если изменяемый атрибут для этого поля имеет значение false, то это поле не должно быть указано в запросе на создание соглашения и значение по умолчанию этого поля будет использоваться при создании соглашения.
Максимальный срок действия соглашения	maxDays	integer	Максимальное число дней окончания срока действия соглашения
Обязательно	required	boolean	Является ли это поле обязательным или необязательным
Видимо	visible	boolean	Отображается ли текущее поле. Если видимый атрибут для этого поля имеет значение false, то это поле не должно отображаться на странице создания соглашения с помощью этого рабочего процесса.

FileInfosDescriptionV6

JSON, содержащий сведения о файлах

Имя	Путь	Тип	Описание
Этикетка	label	string	Отображение метки этого поля для внешних пользователей
Имя	name	string	Имя элемента fileInfo
Обязательно	required	boolean	Является ли это поле обязательным или необязательным
Документы библиотеки рабочих процессов	workflowLibraryDocumentSelectorList	array of WorkflowLibraryDocumentV6	Список документов библиотеки рабочих процессов, из которых можно выбрать один документ библиотеки рабочих процессов с помощью этого объекта fileInfo

WorkflowLibraryDocumentV6

JSON, содержащий сведения о документе библиотеки рабочих процессов

Имя	Путь	Тип	Описание
Этикетка	label	string	Отображаемый текст для этой формы для пользователей рабочего процесса
Дата изменения	modifiedDate	string	Дата последнего изменения документа библиотеки. Формат будет yyy-MM-dd'T'HH:mm:ssZ. Например, например 2016-02-25T18:46:19Z представляет время UTC
Режим общего доступа	sharingMode	string	Указывает, кто должен иметь доступ к этому документу библиотеки. Глобальный общий доступ — это ограниченная операция
Типы шаблонов	templateTypes	array of	Список одного или нескольких типов шаблонов библиотеки
Идентификатор документа библиотеки рабочих процессов	workflowLibDoc	string	Идентификатор документа библиотеки рабочих процессов, который можно указать в качестве входного файла в запросе на создание пользовательского соглашения рабочего процесса

LocaleFieldInfoDescriptionV6

JSON, содержащий подробные сведения о языковом стандарте рабочего процесса

Имя	Путь	Тип	Описание
Доступные языковые стандарта	availableLocales	array of string	Какие языковые параметры можно выбрать для этого рабочего процесса
Значение по умолчанию	defaultValue	string	Значение по умолчанию поля, если входные данные для этого поля не указаны, и это поле является обязательным.
Возможно изменение	editable	boolean	Можно ли изменить текущее поле. Если изменяемый атрибут для этого поля имеет значение false, то это поле не должно быть указано в запросе на создание соглашения и значение по умолчанию этого поля будет использоваться при создании соглашения.
Обязательно	required	boolean	Является ли это поле обязательным или необязательным
Видимо	visible	boolean	Отображается ли текущее поле. Если видимый атрибут для этого поля имеет значение false, то это поле не должно отображаться в пользовательском интерфейсе создания соглашения с помощью этого рабочего процесса для пользователя

MergeFieldInfoDescriptionV6

JSON, содержащий подробные сведения о поле слияния

Имя	Путь	Тип	Описание
Значение по умолчанию	defaultValue	string	Значение по умолчанию поля, если входные данные для этого поля не указаны, и это поле является обязательным.
Отображаемое имя	displayName	string	Отображаемый текст для этого настраиваемого поля
Возможно изменение	editable	boolean	Можно ли изменить текущее поле. Если изменяемый атрибут для этого поля имеет значение false, то это поле не должно быть указано в запросе на создание соглашения и значение по умолчанию этого поля будет использоваться при создании соглашения.
Имя настраиваемого поля	fieldName	string	Имя настраиваемого поля в этом рабочем процессе
Обязательно	required	boolean	Является ли это поле обязательным или необязательным
Видимо	visible	boolean	Должно ли текущее поле отображаться на странице создания соглашения. Если видимый атрибут для этого поля имеет значение false, то это поле не должно отображаться на странице создания соглашения с помощью этого рабочего процесса.

PasswordFieldInfoDescriptionV6

JSON, содержащий подробные сведения о пароле

Имя	Путь	Тип	Описание
Пароль	defaultValue	string	Значение по умолчанию поля сведений о пароле
Возможно изменение	editable	boolean	Можно ли изменить текущее поле. Если изменяемый атрибут для этого поля имеет значение false, то это поле не должно быть указано в запросе на создание соглашения и значение по умолчанию этого поля будет использоваться при создании соглашения.
Этикетка	label	string	Метка поля пароля
Имя	name	string	Имя поля пароля
Обязательно	required	boolean	Является ли это поле обязательным или необязательным
Видимо	visible	boolean	Отображается ли поле сведений о пароле на странице создания соглашения

RecipientsListInfoDescriptionV6

JSON, содержащий подробные сведения о списке получателей

Имя	Путь	Тип	Описание
Разрешить отправителю	allowSender	boolean	Разрешено ли отправителю в качестве получателя
Разрешить отправителю	allowfax	boolean	Разрешено или нет факса
Метод проверки подлинности	authenticationMethod	string	Метод проверки подлинности для текущего списка получателей, чтобы иметь доступ к просмотру и подписи документа,
Значение электронной почты и факса по умолчанию	defaultValue	string	Номер электронной почты или факса по умолчанию
Возможно изменение	editable	boolean	Можно ли изменить текущее поле. Если изменяемый атрибут для этого поля имеет значение false, то это поле не должно быть указано в запросе на создание соглашения и значение по умолчанию этого поля будет использоваться при создании соглашения.
Этикетка	label	string	Отображаемый текст для пользователя рабочего процесса, который можно использовать для текущего списка получателей
Максимальное число получателей	maxListCount	integer	Максимальное количество записей, разрешенных в текущем списке получателей
Минимальные получатели	minListCount	integer	Минимальное количество записей, разрешенных в текущем списке получателей
Имя списка сведений получателя	name	string	Имя текущего списка сведений получателя
Роль участника	role	string	Текущая роль участника
Видимо	visible	boolean	Отображается ли текущее поле. Если видимый атрибут для этого поля имеет значение false, то это поле не должно отображаться в пользовательском интерфейсе создания соглашения с помощью этого рабочего процесса для пользователя.

WorkflowDescriptionV6

JSON, содержащий подробные сведения о рабочем процессе

Имя	Путь	Тип	Описание
agreementNameInfo	agreementNameInfo	WorkflowDefaultParamsV6	JSON, содержащий объект params рабочего процесса по умолчанию
authoringInfo	authoringInfo	WorkflowDefaultParamsV6	JSON, содержащий объект params рабочего процесса по умолчанию
Сведения о списке CC	ccsListInfo	array of CCsListInfoDescriptionV6	Сведения о поле ввода списка CC в запросе на создание соглашения
Дата создания рабочего процесса	created	string	День создания рабочего процесса
Описание рабочего процесса	description	string	Описание, предоставленное для этого рабочего процесса во время его создания
Отображаемое имя рабочего процесса	displayName	string	Отображаемое имя рабочего процесса
expirationInfo	expirationInfo	ExpirationFieldInfoDescriptionV6	JSON, содержащий сведения об истечении срока действия
Сведения о файлах	fileInfos	array of FileInfosDescriptionV6	Сведения о поле ввода сведений о файле в запросе на создание соглашения
localeInfo	localeInfo	LocaleFieldInfoDescriptionV6	JSON, содержащий подробные сведения о языковом стандарте рабочего процесса
Сведения о полях слияния	mergeFieldsInfo	array of MergeFieldInfoDescriptionV6	Сведения о поле ввода пользовательских сведений в запросе на создание соглашения
messageInfo	messageInfo	WorkflowDefaultParamsV6	JSON, содержащий объект params рабочего процесса по умолчанию
Дата изменения	modified	string	День последнего изменения рабочего процесса
Имя рабочего процесса	name	string	Имя рабочего процесса
passwordInfo	passwordInfo	PasswordFieldInfoDescriptionV6	JSON, содержащий подробные сведения о пароле
Сведения о списке получателей	recipientsListInfo	array of RecipientsListInfoDescriptionV6	Сведения о поле ввода сведений о реджеентах в запросе на создание соглашения
Область рабочего процесса	scope	string	Область рабочего процесса
Состояние рабочего процесса	status	string	Состояние рабочего процесса
Идентификатор инициатора рабочего процесса	originatorId	string	Исходный источник рабочего процесса
Идентификатор области рабочего процесса	scopeId	string	Идентификатор области. В настоящее время применимо только для области GROUP, и значение будет groupId

BooleanSettingInfoV6

Имя	Путь	Тип	Описание
Ценность	value	boolean	Значение параметра
Наследование	inherited	boolean	Значение True, если параметр наследуется от значения группы или учетной записи.

SettingsInfoV6

Имя	Путь	Тип	Описание
libaryDocumentCreationVisible	libaryDocumentCreationVisible	BooleanSettingInfoV6
sendRestrictedToWorkflows	sendRestrictedToWorkflows	BooleanSettingInfoV6
userCanSend	userCanSend	BooleanSettingInfoV6
widgetCreationVisible	widgetCreationVisible	BooleanSettingInfoV6

UserGroupInfoV6

Имя	Путь	Тип	Описание
Идентификатор группы	id	string	Уникальный идентификатор группы
Администратор группы	isGroupAdmin	boolean	Значение True, если пользователь является администратором группы
Основная группа	isPrimaryGroup	boolean	Значение True, если группа является основной группой пользователя
Состояние	status	string	Состояние членства в группе
Дата создания	createdDate	date	Была создана группа даты
Имя группы	name	string	Имя группы
settings	settings	SettingsInfoV6

UserGroupsInfoV6

JSON, содержащий список групп для данного пользователя

Имя	Путь	Тип	Описание
Список групп пользователей	groupInfoList	array of UserGroupInfoV6	Массив элементов сведений о группе пользователей

AgreementViews

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

Имя	Путь	Тип	Описание
Список представлений соглашений	agreementViewList	array of AgreementView	Представления соглашения

AgreementView

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

Имя	Путь	Тип	Описание
URL-адрес представления	url	string	URL-адрес расположения ресурса
Внедренный код	embeddedCode	string	Внедренный код URL-адреса ресурса
Expiration	expiration	string	Истечение срока действия URL-адреса пользователя
Текущее представление	isCurrent	boolean	Значение True, если это представление является текущим представлением

бинарный

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

объект

Это тип object.

file

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