Лекс Power Sign (предварительная версия)
Lex Persona является европейским поставщиком услуг доверия, предлагающим ряд решений электронной подписи. При использовании Lex Enterprise у вас есть доступ ко всем уровням подписи eIDAS, а также к большому количеству методов проверки подлинности подписи. Ваши книги подписи внедрены в цифровые рабочие процессы. Автоматизация подключений между Lex Enterprise и всеми средствами для устранения повторяющихся задач, повышения эффективности и ускорения бизнеса.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Поддержка Lex Persona |
| URL | https://support.lex-persona.com |
| Адрес электронной почты | support@lex-persona.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Лекс Persona |
| Веб-сайт | https://www.lex-persona.com |
| Политика конфиденциальности | https://www.lex-persona.com/politique-de-confidentialite/ |
| Категории | Искусственный интеллект; Сайт |
Lex Persona является европейским поставщиком услуг доверия, предлагающим ряд решений электронной подписи. С помощью этого соединителя вы можете легко добавить возможность электронной подписи в приложение на основе Майкрософт (PowerApp, веб-приложение на основе .NET, Dynamics...) и среду (Outlook, Sharepoint, Teams...). Соединитель поддерживается нашим диспетчером рабочих процессов Lex Enterprise. Вы можете создавать рабочие процессы подписи electronc, состоящие из различных типов шагов, которые могут выполняться в последовательности и (или) параллельно. Соединитель поддерживает все уровни подписи eIDAS и предлагает широкий спектр методов проверки подлинности подписи (OTP, SSO, France Connect, Identité Numérique La Poste, аппаратные токены...)
Предпосылки
Чтобы продолжить, вам потребуется следующее:
- Подписка Lex Enterprise. Использование плана пробной версии для тестирования
Требования к среде:
- План Microsoft Power Apps или Power Automate с пользовательским компонентом соединителя
- Средства командной строки Power Platform
Получение учетных данных
Обратитесь к нашим представителям по продажам, commercial@lex-persona.com чтобы получить подписку Lex Enteprise или учетную запись в наших пробных системах.
Подключитесь к порталу Lex Enterprise с учетной записью и создайте ключ API.
Начало работы с соединителем
Сначала создайте подключение для соединителя. Задайте для метода проверки подлинности ключ API, укажите ключ API ("Медведь act_XXXXXXX") и укажите, что ключ API должен быть помещен в заголовок autrorization вызовов API.
Ниже приведены действия по созданию простого рабочего процесса подписи.
- сразу после tigger получите подключенный идентификатор пользователя Lex Enterprise (этот идентификатор необходим для создания рабочего процесса) с действием Retrieve Me
- страницы согласия поиска с action_ страниц согласия поиска. Текстовый параметр можно использовать для поиска страниц согласия по имени (страницы согласия определяют уровень подписи и предварительно настроены в среде Lex Enterprise).
- создайте рабочий процесс подписи с помощью действия "Создать рабочий процесс ". На этом шаге необходимо указать сведения о подписях.
- профили сигнатуры поиска с помощью действия профилей подписей поиска. Текстовый параметр можно использовать для поиска профилей подписей по имени (профили подписей управляют некоторыми аспектами поведения страниц согласия. Принудительно прокрутите подписыватель до нижней части документа, прежде чем подписывать, например)
- Получение документа из среды (Sharepoint, Outlook, OneDrive...)
- добавьте документ в рабочий процесс с действием "Создать часть ", установив для параметра createDocument значение true
- запустите рабочий процесс с действием "Обновить рабочий процесс ", установив состояние рабочего процесса для запуска
Обратите внимание: Соединитель по умолчанию связан с нашим пробным сервером. Если вы хотите связать соединитель с собственным клиентом, необходимо изменить URL-адрес узла в определении безопасности соединителя или в файле apiDefinitions.json:
- "host": "yourtenant.lexpersona.com",
Сведения о проблемах и ограничениях
Действие "Создать документ " принимает список частей документа в полезных данных. Однако при предоставлении нескольких частей будет учитываться только первый (это связано с ошибкой в нашем API. Он будет исправлен в следующем выпуске соединителя.
Следовательно, если вы хотите добавить несколько документов в рабочий процесс, необходимо выполнить вызов создания части с параметром createDocument , равным true для каждого документа.
Распространенные ошибки и средства устранения неполадок
В случае сбоя вызова API ответ на вызов API содержит комплексное сообщение об ошибке, отображаемое в журнале выполнения соединителя. Сообщение содержит также идентификатор журнала, чтобы при необходимости получить дополнительные сведения об ошибке, можно подключиться к порталу Lex Enteprise и обратиться к файлу журнала сервера. Alternativley, вы можете настроить запрос Postman для поиска журналов наших серверов (plase ознакомьтесь с документацией: https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs).
Ниже приведены более распространенные коды ошибок HTTP, возвращаемые нашим API:
- Ошибка 400 — недопустимый запрос. Есть что-то неправильное в запросе paylod. Обратитесь к журналу, чтобы найти сведения о причине ошибки
- Ошибка 401 — несанкционированная. У Yo нет прав доступа для выполнения этой операции. Проверка прав доступа пользователей Lex Persona
- Ошибка 403 — запрещено. Ключ API включен или отключен
- Ошибка 404 — не найдена. В URL-адресе запроса возникает ошибка
Дополнительные сведения о каждом вызове API возможные коды ошибок () можно также проверить в нашей документации.https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html
Часто задаваемые вопросы
Форматы документов, поддерживаемые соединителем
Документы, которые можно отправить для подписи, могут иметь форматы pdf, docx, pptx и xlsx. Соединитель преобразует документы в pdf при необходимости, а подписи будут иметь формат PAdES.
Также можно подписать XML-документы. В этом случае преобразование не будет применено, а подписи будут иметь формат XAdES.
Также можно отправить ZIP-файлы. Соединитель распакует архив и добавит каждый документ в рабочий процесс.
Вы также можете добавлять вложения в рабочие процессы подписей. Вложение не подписано и может иметь любой формат.
Может ли документ иметь несколько подписок
Да. Количество подписей документа не ограничено.
Можно ли подписывать несколько документов одновременно
Да. Вы можете добавить несколько документов в рабочий процесс, и все документы будут подписаны одновременно. Обратите внимание, что в этом случае набор документов будет юридически связан и что система создаст уникальный файл доказательств.
Вы также можете создать мутlpiple workglows coantaining тот же подписыватель. Во время подписи список документов будет представлен подписывательу, и у подписывателя будет возможность выбрать документы, которые она хлынет подписывать. В этом случае документы будут юридически независимыми, файл доказательств будет создан для каждого документа.
Можно ли подписать документ в автономном режиме
Нет. Для доступа к страницам согласия требуется подключение intenet.
Можно ли отправлять автоматические ремидеры подписи подписывателям
Да. Можно настроить период напоминания и максимальное количество напоминаний для отправки.
Можно ли изменить уже запущенный рабочий процесс подписи
Да. Перед любой подписью можно изменить все, что в рабочем процессе. После первой подписи невозможно изменить документы, но по-прежнему можно изменить шаги рабочего процесса.
Что такое срок действия однократных паролей
Срок действия одноразовых паролей составляет две минуты (счетчик отображается на страницах согласия).
Можно ли проверить допустимость электронной подписи
Панель подписей Adobe Acrobat можно использовать для проверки допустимости подписей , содержащихся в pdf-документе. Кроме того, можно использовать веб-службу проверки доверенной подписи (https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation например)
Каковы условия хранения документов Lex Persona
По умолчанию мы храним документы доказательства файлов на наших серверах. Tou может выполнять поиск и скачивание документов в любое время. При запросе мы можем, однако, при необходимости удалить документы с наших серверов.
Хранит ли Лекс Persona маркеры меток времени
Нет. Мы не сохраняем маркеры меток времени. При необходимости эти маркеры можно экстраккстить из подписанных документов.
Есть ли срок вывода для подписанного документа
Да. Отмена вывода зависит от юридических условий, применимых к документу.
Можно ли отменить рабочий процесс подписи
Да. Пользователь authoriezd может отменить запущенный рабочий процесс подписи в любое время. Файл вытеснений не будет создан, и если документ уже подписан одним или несколькими подписывателями, то сгнатуры будут отменены.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API | securestring | Ключ API для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Извлеките меня |
Получение идентификатора подключенного пользователя |
| Макеты метаданных поиска |
Макеты рабочих процессов поиска |
| Обновление документа |
Обновление документа |
| Обновление контакта |
Изменение существующих контактных данных |
| Обновление макета метаданных |
Обновление макета метаданных |
| Обновление профиля подписи |
Обновление профиля подписи |
| Обновление рабочего процесса |
Обновление рабочего процесса |
| Поиск документов |
Поиск документов |
| Поиск контактов |
Поиск контактов |
| Поиск рабочих процессов |
Поиск рабочих процессов |
| Получение URL-адреса страницы константной страницы |
Создание и получение URL-адреса страницы согласия для получателя |
| Получение документа |
Получение документа |
| Получение контакта |
Получение контактных данных из идентификатора контакта |
| Получение макета метаданных |
Получение макета рабочего процесса |
| Получение профиля подписи |
Получение профиля подписи |
| Получение рабочего процесса |
Получение рабочего процесса из идентификатора рабочего процесса |
| Получение сопоставления метаданных |
Получение сопоставления метаданных указанного клиента |
| Профили подписи поиска |
Профили подписи поиска |
| Скачивание документов рабочего процесса |
Скачивание документов рабочего процесса |
| Скачивание файла доказательств |
Скачивание файла доказательств рабочего процесса |
| Создание документа |
Создание документа из предварительно созданных частей |
| Создание контакта |
Добавление контакта в список контактов текущего пользователя |
| Создание макета метаданных |
Создание макета метаданных |
| Создание профиля подписи |
Создание профиля подписи |
| Создание рабочего процесса |
Создание рабочего процесса |
| Создание части |
Создание части документа |
| Страница получения согласия |
Получение сведений о странице согласия из идентификатора страницы согласия |
| Страницы согласия поиска |
Страницы согласия поиска |
| Удаление документа |
Удаление документа |
| Удаление контакта |
Удаление контакта из списка контектов текущего пользователя |
| Удаление рабочего процесса |
Удаление рабочего процесса |
Извлеките меня
Макеты метаданных поиска
Макеты рабочих процессов поиска
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Поиск текста
|
text | string |
Поиск текста |
|
|
Поиск отключен
|
items.isDisabled | string |
Поиск отключенных макетов |
|
|
Имя поиска
|
items.name | string |
Поиск по имени макета |
|
|
Поиск метаданных
|
items.dataConfigurations.slot | string |
Поиск по присутствию метаданных |
|
|
Дата создания поиска
|
items.created | string |
Поиск по дате создания |
|
|
Дата обновления поиска
|
items.updated | string |
Поиск по дате последнего обновления |
|
|
Сортировать по
|
sortBy | string |
Поле, используемое для сортировки результата поиска |
|
|
Порядок сортировки
|
sortOrder | string |
Направление сортировки |
|
|
Элементы на странице
|
itemsPerPage | string |
Количество элементов на страницу в ответе |
|
|
Индекс страницы
|
pageIndex | string |
Индекс возвращаемой страницы |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
items
|
items | layouts |
Обновление документа
Обновление документа
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
documentId | True | string |
Идентификатор документа |
|
Тип контента
|
Content-Type | True | string |
Тип контента |
|
signatureProfileId
|
signatureProfileId | string |
Профиль подписи для аплики к этому документу |
|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
|
ImagePage
|
imagePage | float |
ImagePage |
|
|
imageWidth
|
imageWidth | float |
imageWidth |
|
|
imageX
|
imageX | float |
imageX |
|
|
imageY
|
imageY | float |
imageY |
Возвращаемое значение
- Тело
- document
Обновление контакта
Изменение существующих контактных данных
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Контактный номер
|
contactId | True | string |
Идентификатор контакта |
|
Тип контента
|
Content-Type | True | string |
Тип контента |
|
Электронная почта контакта
|
string |
Электронная почта контакта |
||
|
Номер телефона контакта
|
phoneNumber | string |
Номер телефона контакта |
|
|
Имя контакта
|
firstName | string |
Имя контакта |
|
|
Фамилия контакта
|
lastName | string |
Фамилия контакта |
|
|
Страна контакта
|
country | string |
Страна контакта |
Возвращаемое значение
- Тело
- contact
Обновление макета метаданных
Обновление макета метаданных
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор арендатора
|
layoutId | True | string |
Идентификатор макета |
|
Тип контента
|
Content-Type | True | string |
Тип контента |
|
Имя
|
name | True | string |
Имя макета |
|
Отключен
|
isDisabled | boolean |
Если задано значение true, макет будет отключен |
|
|
щель
|
slot | string |
Элемент метаданных (data1 to data8) |
|
|
default
|
default | string |
Значение метаданных по умолчанию в этом макете |
|
|
optional
|
optional | boolean |
Если значение равно true, предоставление значения не является обязательным |
|
|
Только для чтения
|
readonly | boolean |
Переопределение значения может быть переопределено |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Если задано значение true, значение сохраняется в рабочих процессах. |
Возвращаемое значение
Макет метаданных
- Тело
- layout
Обновление профиля подписи
Обновление профиля подписи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор профиля подписи
|
spId | True | string |
Идентификатор профиля подписи |
|
Тип контента
|
Content-Type | True | string |
Тип контента |
|
Значение по умолчанию
|
isDefault | string |
Делает этот профиль подписи стандартным |
|
|
Отключен
|
isDisabled | string |
Отключение этого профиля подписи |
|
|
Имя
|
name | string |
Имя профиля подписи |
|
|
Тип подписи
|
signatureType | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
|
Принудительное прокрутка до нижней части документа
|
forceScrollDocument | boolean |
Принудительное прокрутка подписывющего элемента в нижней части документа |
|
|
Режим видимой подписи
|
pdfVisibleSignatureMode | string |
Режим видимой подписи (разрешенный, отключенный, noImage) |
|
|
Текст подписи
|
pdfSignatureImageText | string |
Текст, отображаемый на сигнатурах |
|
|
Цвет текста подписи
|
pdfSignatureImageTextColor | string |
Цвет текста, отображаемого на полях с заготовками |
|
|
Размер текста подписи
|
pdfSignatureImageTextSize | number |
Размер текста, отображаемого на полях с заготовками |
Возвращаемое значение
- Тело
- signatureProfile
Обновление рабочего процесса
Обновление рабочего процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочего процесса
|
workflowId | True | string |
Идентификатор рабочего процесса для обновления |
|
Тип контента
|
Content-Type | string |
Тип контента |
|
|
Идентификатор пользователя
|
userId | string |
Идентификатор владельца рабочего процесса |
|
|
Имя
|
name | string |
Имя рабочего процесса |
|
|
Description
|
description | string |
Описание рабочего процесса |
|
|
id
|
id | string |
Идентификатор шага |
|
|
stepType
|
stepType | string |
подпись или утверждение |
|
|
consentPageId
|
consentPageId | True | string |
Идентификатор страницы согласия (уровень подписи), связанный с этим получателем |
|
электронная почта
|
True | string |
Электронная почта получателя |
|
|
userId
|
userId | string |
ссылка на пользователя LE вместо создания получателя на лету |
|
|
номер телефона
|
phoneNumber | string |
номер мобильного телефона reicpient |
|
|
Имя
|
firstName | string |
Имя получателя |
|
|
lastName
|
lastName | string |
Фамилия получателя |
|
|
country
|
country | string |
Код страны получателя |
|
|
preferredLocale
|
preferredLocale | string |
Код языкового стандарта получателя |
|
|
organizationId
|
organizationId | string |
Идентификатор организации LE получателя |
|
|
requiredRecipients
|
requiredRecipients | number |
минимальное количество подписчиков, которые должны подписаться, чтобы выполнить следующий шаг |
|
|
validityPeriod
|
validityPeriod | number |
Длительность действия шага |
|
|
inviteperiod
|
inviteperiod | number |
Частота напоминаний сигнатур |
|
|
maxInvites
|
maxInvites | number |
максимальное количество напоминаний подписи |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
управляет доставкой подписанного документа подписывателям |
|
|
allowComments
|
allowComments | boolean |
разрешить или запретить комментарии на этом шаге |
|
|
hideAttachments
|
hideAttachments | boolean |
управляет отображением вложений для подписчиков |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
управляет отображением других подписчиков для подписывателя |
|
|
Уведомления о событиях
|
notifiedEvents | array of string |
Уведомления о событиях рабочего процесса |
|
|
userId
|
userId | string |
Идентификатор пользователя наблюдателя |
|
|
уведомлениеEvents
|
notifiedEvents | array of string |
События рабочего процесса, которые будут уведомлены этому наблюдателю |
|
|
электронная почта
|
string |
электронная почта |
||
|
Состояние рабочего процесса
|
workflowStatus | string |
Текущее состояние рабочего процесса |
|
|
data1
|
data1 | string |
первые метаданные |
|
|
data2
|
data2 | string |
второй метаданный |
|
|
data3
|
data3 | string |
третие метаданные |
|
|
data4
|
data4 | string |
четвертые метаданные |
|
|
data5
|
data5 | string |
пятые метаданные |
|
|
data6
|
data6 | string |
Шестые метаданные |
|
|
data7
|
data7 | string |
седьмое метаданные |
|
|
data8
|
data8 | string |
Метаданные высоты |
Возвращаемое значение
- Тело
- workflow
Поиск документов
Поиск документов
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Поиск текста
|
text | string |
Поиск текста |
|
|
Макет метаданных поиска
|
items.layoutId | string |
Поиск по макету метаданных |
|
|
Группа поиска
|
items.groupId | string |
Поиск по группам пользователей |
|
|
Поиск пользователя
|
items.userId | string |
Поиск по владельцу |
|
|
Идентификатор рабочего процесса поиска
|
items.workflowId | string |
Поиск по идентификатору рабочего процесса |
|
|
Имя рабочего процесса поиска
|
items.workflowName | string |
Поиск по имени рабочего процесса |
|
|
Поиск метаданных 1
|
items.data1 | string |
Поиск по значению метаданных 1 |
|
|
Поиск метаданных 2
|
items.data2 | string |
Поиск по значению метаданных 2 |
|
|
Поиск метаданных 3
|
items.data3 | string |
Поиск по значению метаданных 3 |
|
|
Поиск метаданных 4
|
items.data4 | string |
Поиск по значению метаданных 4 |
|
|
Поиск метаданных 5
|
items.data5 | string |
Поиск по значению метаданных 5 |
|
|
Поиск метаданных 6
|
items.data6 | string |
Поиск по значению метаданных 6 |
|
|
Поиск метаданных 7
|
items.data7 | string |
Поиск по значению метаданных 7 |
|
|
Поиск метаданных 8
|
items.data8 | string |
Поиск по значению метаданных 8 |
|
|
Профиль подписи поиска
|
items.signatureProfileId | string |
Поиск по профилю подписи |
|
|
Дата создания поиска
|
items.created | string |
Поиск по дате создания |
|
|
Дата обновления поиска
|
items.updated | string |
Поиск по дате последнего обновления |
|
|
Сортировать по
|
sortBy | string |
Поле, используемое для сортировки результата поиска |
|
|
Порядок сортировки
|
sortOrder | string |
Направление сортировки |
|
|
Элементы на странице
|
itemsPerPage | string |
Количество элементов на страницу в ответе |
|
|
Индекс страницы
|
pageIndex | string |
Индекс возвращаемой страницы |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
items
|
items | documents |
Поиск контактов
Поиск контактов
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Поиск текста
|
text | string |
Поиск по тексту |
|
|
Поиск по электронной почте
|
items.email | string |
Поиск по электронной почте |
|
|
Поиск номера телефона
|
items.phoneNumber | string |
Поиск по номеру телефона |
|
|
Имя поиска
|
items.fisrtName | string |
Поиск по имени |
|
|
Поиск фамилии
|
items.lastName | string |
Поиск по фамилии |
|
|
Страна поиска
|
items.country | string |
Поиск по стране |
|
|
Элементы на странице
|
itemsPerPage | number |
Количество элементов на страницу в ответе |
|
|
Индекс страницы
|
pageIndex | number |
Индекс возвращаемой страницы |
Возвращаемое значение
- Тело
- contacts
Поиск рабочих процессов
Поиск рабочих процессов
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Принять
|
Accept | string |
Принять |
|
|
Поиск текста
|
text | string |
Поиск текста |
|
|
Макет метаданных поиска
|
items.layoutId | string |
Поиск по макету метаданных |
|
|
Шаблон поиска
|
items.templateId | string |
Поиск по шаблону рабочего процесса |
|
|
Группа поиска
|
items.groupId | string |
Поиск по группам пользователей |
|
|
Поиск пользователя
|
items.userId | string |
Поиск по владельцу |
|
|
Поиск по электронной почте
|
items.email | string |
Поиск по электронной почте владельца |
|
|
Имя поиска
|
items.firstname | string |
Поиск по имени владельца |
|
|
Поиск фамилии
|
items.lastname | string |
Поиск по фамилии владельца |
|
|
Состояние поиска
|
items.workflowStatus | string |
Поиск по состоянию рабочего процесса |
|
|
Поиск метаданных 1
|
items.data1 | string |
Поиск по значению метаданных 1 |
|
|
Поиск метаданных 2
|
items.data2 | string |
Поиск по значению метаданных 2 |
|
|
Поиск метаданных 3
|
items.data3 | string |
Поиск по значению метаданных 3 |
|
|
Поиск метаданных 4
|
items.data4 | string |
Поиск по значению метаданных 4 |
|
|
Поиск метаданных 5
|
items.data5 | string |
Поиск по значению метаданных 5 |
|
|
Поиск метаданных 6
|
items.data6 | string |
Поиск по значению метаданных 6 |
|
|
Поиск метаданных 7
|
items.data7 | string |
Поиск по значению метаданных 7 |
|
|
Поиск метаданных 8
|
items.data8 | string |
Поиск по значению метаданных 8 |
|
|
Дата создания поиска
|
items.created | string |
Поиск по дате создания |
|
|
Дата обновления поиска
|
items.updated | string |
Поиск по дате последнего обновления |
|
|
Дата начала поиска
|
items.started | string |
Поиск по дате начала |
|
|
Сортировать по
|
sortBy | string |
Поле, используемое для сортировки результата поиска |
|
|
Порядок сортировки
|
sortOrder | string |
Направление сортировки |
|
|
Элементы на странице
|
itemsPerPage | string |
Количество элементов на страницу в ответе |
|
|
Индекс страницы
|
pageIndex | string |
Индекс возвращаемой страницы |
Возвращаемое значение
- Тело
- workflows
Получение URL-адреса страницы константной страницы
Создание и получение URL-адреса страницы согласия для получателя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочего процесса
|
workflowId | True | string |
Идентификатор рабочего процесса |
|
Электронная почта получателя
|
recipientEmail | string |
Электронная почта соответствующего получателя |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес страницы согласия для соответствующего получателя
|
inviteUrl | string |
URL-адрес страницы согласия для соответствующего получателя |
Получение документа
Получение документа
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
documentId | True | string |
Идентификатор документа |
Возвращаемое значение
- Тело
- document
Получение контакта
Получение контактных данных из идентификатора контакта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Контактный номер
|
contactId | True | string |
Идентификатор контакта |
|
Тип контента
|
Content-Type | True | string |
Тип контента |
Возвращаемое значение
- Тело
- contact
Получение макета метаданных
Получение макета рабочего процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор макета
|
layoutId | True | string |
Идентификатор макета |
Возвращаемое значение
Макет метаданных
- Тело
- layout
Получение профиля подписи
Получение профиля подписи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор профиля подписи
|
spId | True | string |
Идентификатор профиля подписи |
Возвращаемое значение
- Тело
- signatureProfile
Получение рабочего процесса
Получение рабочего процесса из идентификатора рабочего процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочего процесса
|
workflowId | True | string |
Идентификатор рабочего процесса |
Возвращаемое значение
- Тело
- workflow
Получение сопоставления метаданных
Получение сопоставления метаданных указанного клиента
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор арендатора
|
tenantId | True | string |
Идентификатор клиента |
Возвращаемое значение
- Тело
- dataMapping
Профили подписи поиска
Профили подписи поиска
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Поиск текста
|
text | string |
Поиск текста |
|
|
Поиск по умолчанию
|
items.isDefault | string |
Поиск профилей подписей по умолчанию |
|
|
Поиск отключен
|
items.isDisabled | string |
Поиск отключенных профилей подписей |
|
|
Имя поиска
|
items.name | string |
Поиск по имени профиля подписи |
|
|
Тип документа поиска.
|
items.documentType | string |
Поиск по типу документа |
|
|
Тип подписи поиска
|
items.signatureType | string |
Поиск по типу подписи |
|
|
Дата создания поиска
|
items.created | string |
Поиск по дате создания |
|
|
Дата обновления поиска
|
items.updated | string |
Поиск по дате последнего обновления |
|
|
Сортировать по
|
sortBy | string |
Поле, используемое для сортировки результата поиска |
|
|
Порядок сортировки
|
sortOrder | string |
Направление сортировки |
|
|
Элементы на странице
|
itemsPerPage | string |
Количество элементов на страницу в ответе |
|
|
Индекс страницы
|
pageIndex | string |
Индекс возвращаемой страницы |
Возвращаемое значение
- Тело
- signatureProfiles
Скачивание документов рабочего процесса
Скачивание документов рабочего процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочего процесса
|
workflowId | True | string |
Идентификатор рабочего процесса |
Возвращаемое значение
- response
- binary
Скачивание файла доказательств
Скачивание файла доказательств рабочего процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочего процесса
|
workflowId | True | string |
Идентификатор рабочего процесса |
|
Принять
|
Accept | True | string |
Принять |
Возвращаемое значение
- response
- binary
Создание документа
Создание документа из предварительно созданных частей
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочего процесса
|
workflowId | True | string |
Идентификатор соответствующего рабочего процесса |
|
Тип контента
|
Content-Type | True | string |
Тип контента |
|
Тип контента
|
contentType | string |
Тип контента |
|
|
filename
|
filename | string |
filename |
|
|
hash
|
hash | string |
hash |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
Профиль подписи для этого документа |
Возвращаемое значение
- Тело
- document
Создание контакта
Добавление контакта в список контактов текущего пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пользователя
|
userId | True | string |
Пользователь, которому принадлежит контакт |
|
Тип контента
|
Content-Type | True | string |
Тип контента |
|
Контактный адрес электронной почты
|
True | string |
Контактный адрес электронной почты |
|
|
Номер телефона Contatct
|
phoneNumber | string |
номер телефона |
|
|
Имя контакта
|
firstName | True | string |
Имя |
|
Фамилия контакта
|
lastName | True | string |
lastName |
|
Страна контактов
|
country | string |
country |
Возвращаемое значение
- Тело
- contact
Создание макета метаданных
Создание макета метаданных
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор арендатора
|
tenantId | True | string |
Идентификатор макета |
|
Тип контента
|
Content-Type | True | string |
Тип контента |
|
Имя
|
name | True | string |
Имя макета |
|
Отключен
|
isDisabled | boolean |
Если задано значение true, макет будет отключен |
|
|
щель
|
slot | string |
Элемент метаданных (data1 to data8) |
|
|
default
|
default | string |
Значение метаданных по умолчанию в этом макете |
|
|
optional
|
optional | boolean |
Если значение равно true, предоставление значения не является обязательным |
|
|
Только для чтения
|
readonly | boolean |
Переопределение значения может быть переопределено |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Если задано значение true, значение сохраняется в рабочих процессах. |
Возвращаемое значение
Макет метаданных
- Тело
- layout
Создание профиля подписи
Создание профиля подписи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор арендатора
|
tenantId | True | string |
Идентификатор клиента |
|
Тип контента
|
Content-Type | True | string |
Тип контента |
|
Значение по умолчанию
|
isDefault | True | string |
Делает этот профиль подписи стандартным |
|
Отключен
|
isDisabled | string |
Отключение этого профиля подписи |
|
|
Имя
|
name | True | string |
Имя профиля подписи |
|
Тип документа
|
documentType | True | string |
pdf, xml, word, excel, powerpoint, другие |
|
Тип подписи
|
signatureType | True | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
Принудительное прокрутка до нижней части документа
|
forceScrollDocument | True | boolean |
Принудительное прокрутка подписывющего элемента в нижней части документа |
|
Режим видимой подписи
|
pdfVisibleSignatureMode | string |
Режим видимой подписи (разрешенный, отключенный, noImage) |
|
|
Текст подписи
|
pdfSignatureImageText | string |
Текст, отображаемый на сигнатурах |
|
|
Цвет текста подписи
|
pdfSignatureImageTextColor | string |
Цвет текста, отображаемого на полях с заготовками |
|
|
Размер текста подписи
|
pdfSignatureImageTextSize | number |
Размер текста, отображаемого на полях с заготовками |
Возвращаемое значение
- Тело
- signatureProfile
Создание рабочего процесса
Создание рабочего процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пользователя
|
userId | True | string |
Идентификатор пользователя собственного рабочего процесса |
|
Тип контента
|
Content-Type | string |
Тип контента |
|
|
Имя
|
name | True | string |
Имя рабочего процесса |
|
Description
|
description | string |
Описание рабочего процесса |
|
|
id
|
id | string |
Идентификатор шага |
|
|
stepType
|
stepType | string |
подпись или утверждение |
|
|
consentPageId
|
consentPageId | True | string |
Идентификатор страницы согласия (уровень подписи), связанный с этим получателем |
|
электронная почта
|
True | string |
Электронная почта получателя |
|
|
userId
|
userId | string |
ссылка на пользователя LE вместо создания получателя на лету |
|
|
номер телефона
|
phoneNumber | string |
номер мобильного телефона reicpient |
|
|
Имя
|
firstName | string |
Имя получателя |
|
|
lastName
|
lastName | string |
Фамилия получателя |
|
|
country
|
country | string |
Код страны получателя |
|
|
preferredLocale
|
preferredLocale | string |
Код языкового стандарта получателя |
|
|
organizationId
|
organizationId | string |
Идентификатор организации LE получателя |
|
|
requiredRecipients
|
requiredRecipients | number |
минимальное количество подписчиков, которые должны подписаться, чтобы выполнить следующий шаг |
|
|
validityPeriod
|
validityPeriod | number |
Длительность действия шага |
|
|
inviteperiod
|
inviteperiod | number |
Частота напоминаний сигнатур |
|
|
maxInvites
|
maxInvites | number |
максимальное количество напоминаний подписи |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
управляет доставкой подписанного документа подписывателям |
|
|
allowComments
|
allowComments | boolean |
разрешить или запретить комментарии на этом шаге |
|
|
hideAttachments
|
hideAttachments | boolean |
управляет отображением вложений для подписчиков |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
управляет отображением других подписчиков для подписывателя |
|
|
Уведомления о событиях
|
notifiedEvents | array of string |
Уведомления о событиях рабочего процесса |
|
|
userId
|
userId | string |
Идентификатор пользователя наблюдателя |
|
|
уведомлениеEvents
|
notifiedEvents | array of string |
События рабочего процесса, которые будут уведомлены этому наблюдателю |
|
|
электронная почта
|
string |
Электронная почта наблюдателя |
||
|
Идентификатор шаблона
|
templateId | string |
Идентификатор шаблона, из которого производный рабочий процесс |
|
|
Идентификатор макета
|
layoutId | string |
Макет метаданных, используемый в рабочем листе |
|
|
data1
|
data1 | string |
Первые метаданные |
|
|
data2
|
data2 | string |
Второй метаданный |
|
|
data3
|
data3 | string |
Третие метаданные |
|
|
data4
|
data4 | string |
Четвертые метаданные |
|
|
data5
|
data5 | string |
Пятые метаданные |
|
|
data6
|
data6 | string |
Шестое метаданные |
|
|
data7
|
data7 | string |
Седьмое метаданные |
|
|
data8
|
data8 | string |
Метаданные высоты |
Возвращаемое значение
- Тело
- workflow
Создание части
Создание части документа
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочего процесса
|
workflowId | True | string |
Идентификатор соответствующего рабочего процесса |
|
Тип контента
|
Content-Type | True | string |
Тип контента |
|
Ликвидация Котент
|
Content-Disposition | True | string |
Разобщение содержимого |
|
Создание документа
|
createDocuments | string |
Создание документа из этой части |
|
|
Игнорировать вложения
|
ignoreAttachments | string |
Вложения будут игнорироваться |
|
|
Идентификатор профиля подписи
|
signatureProfileId | string |
Часть считается вложением, если опущен |
|
|
Расстегнуть
|
unzip | string |
Распакуть файлы |
|
|
Pdf в PdfA
|
pdf2pdfa | string |
Преобразование pdf-файла в pdf/A |
|
|
Документ
|
document | True | binary |
Переданные данные файла |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Документы
|
documents | array of document |
Созданные документы |
|
игнорируемыеattachments
|
ignoredAttachments | integer |
игнорируемыеattachments |
|
комплектующие
|
parts | array of part |
комплектующие |
Страница получения согласия
Получение сведений о странице согласия из идентификатора страницы согласия
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор страницы согласия
|
cpId | True | string |
Идентификатор страницы согласия |
|
Тип контента
|
Content-Type | True | string |
Тип контента |
Возвращаемое значение
- Тело
- consentPage
Страницы согласия поиска
Страницы согласия поиска
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Поиск текста
|
text | string |
Поиск текста |
|
|
Поиск по умолчанию
|
items.isDefault | string |
Поиск страницы согласия по умолчанию |
|
|
Поиск отключен
|
items.isDisabled | string |
Поиск отключенных страниц согласия |
|
|
Имя поиска
|
items.name | string |
Поиск по имени страницы согласия |
|
|
Тип шага поиска
|
items.stepType | string |
Поиск по пошагового типа |
|
|
Поиск идентификатора клиента
|
items.clientId | string |
Поиск по идентификатору клиента |
|
|
Дата создания поиска
|
items.created | string |
Поиск по дате создания |
|
|
Дата обновления поиска
|
items.updated | string |
Поиск по дате последнего обновления |
|
|
Сортировать по
|
sortBy | string |
Поле для сортировки результата поиска |
|
|
Порядок сортировки
|
sortOrder | string |
Направление сортировки |
|
|
Элементы на странице
|
itemsPerPage | string |
Количество элементов на страницу в ответе |
|
|
Индекс страницы
|
pageIndex | string |
Индекс возвращаемой страницы |
Возвращаемое значение
- Тело
- consentPages
Удаление документа
Удаление документа
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
documentId | True | string |
Идентификатор документа |
Возвращаемое значение
- Тело
- document
Удаление контакта
Удаление контакта из списка контектов текущего пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Контактный номер
|
contactId | True | string |
Идентификатор контакта |
|
Тип контента
|
Content-Type | True | string |
Тип контента |
Возвращаемое значение
- Тело
- contact
Удаление рабочего процесса
Удаление рабочего процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочего процесса
|
workflowId | True | string |
Идентификатор рабочего процесса для удаления |
Возвращаемое значение
- Тело
- workflow
Определения
consentPage
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
allowOrganization
|
allowOrganization | boolean |
Позволяет использовать организации |
|
аутентификацияUser
|
authenticateUser | boolean |
Налагает проверку подлинности подписывщика |
|
clientId
|
clientId | string |
Идентификатор клиента |
|
создано
|
created | number |
Дата создания |
|
emUrl
|
emUrl | string |
URL-адрес диспетчера доказательств |
|
hideDownloads
|
hideDownloads | boolean |
Ссылки на скачивание документов не воспроизводится на страницах согласия |
|
hideMobileQrCode
|
hideMobileQrCode | boolean |
Скрытие QR-кодов на константных страницах |
|
id
|
id | string |
Идентификатор страницы согласия |
|
isCountryRequired
|
isCountryRequired | boolean |
Делает страну обязательной в сведениях о подписях |
|
isDisabled
|
isDisabled | boolean |
Страница согласия отключена |
|
logoResourceId
|
logoResourceId | string |
Идентификатор ресурса логотипа страницы согласия |
|
имя
|
name | string |
Имя страницы согласия |
|
primaryColor
|
primaryColor | string |
Основной цвет страницы согласия |
|
secondaryColor
|
secondaryColor | string |
Дополнительный цвет страницы согласия |
|
sharedPassphrase
|
sharedPassphrase | string |
Общая парольная фраза |
|
Режим подписывания
|
signing mode | string |
Режим подписывания (локальный или сервер) |
|
stepType
|
stepType | string |
тип шага (подпись или утверждение) |
|
tenantId
|
tenantId | string |
Идентификатор арендатора |
|
tsaUrl
|
tsaUrl | string |
URL-адрес центра метки времени |
|
Обновлено
|
updated | number |
Дата последнего изменения |
|
verifyEmail
|
verifyEmail | boolean |
Если задано значение tue, подписывющие будут получать OTPs по электронной почте |
|
verifyPhoneNumber
|
verifyPhoneNumber | boolean |
Если задано значение true, подписывющие будут получать OTPs по текстовым сообщениям |
consentPages
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
items
|
items | array of consentPage |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
общееКоличествоЭлементов
|
totalItems | integer |
общееКоличествоЭлементов |
контакт
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
country
|
country | string |
Страна контактов |
|
создано
|
created | integer |
Дата создания контакта |
|
электронная почта
|
string |
Контактный адрес электронной почты |
|
|
Имя
|
firstName | string |
Имя контакта |
|
id
|
id | string |
Идентификатор контакта |
|
lastName
|
lastName | string |
Контакт lastName |
|
имя
|
name | string |
Имя контакта (имя и фамилия)) |
|
номер телефона
|
phoneNumber | string |
Контактный номер телефона |
|
tenantId
|
tenantId | string |
Идентификатор арендатора |
|
Обновлено
|
updated | integer |
Дата последнего изменения контакта |
|
userId
|
userId | string |
Идентификатор владельца контакта |
contacts
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
items
|
items | array of contact |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
общееКоличествоЭлементов
|
totalItems | integer |
общееКоличествоЭлементов |
dataMapping
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
описание
|
data1.description | string |
Описание метаданных |
|
имя
|
data1.name | string |
Имя метаданных |
|
pattern
|
data1.pattern | string |
Шаблон метаданных |
|
options
|
data1.options | array of object |
options |
|
value
|
data1.options.value | string |
Значение метаданных |
|
type
|
data1.type | string |
type |
|
описание
|
data2.description | string |
Описание метаданных |
|
имя
|
data2.name | string |
Имя метаданных |
|
pattern
|
data2.pattern | string |
Шаблон метаданных |
|
options
|
data2.options | array of object |
options |
|
value
|
data2.options.value | string |
Значение метаданных |
|
type
|
data2.type | string |
type |
|
описание
|
data3.description | string |
Описание метаданных |
|
имя
|
data3.name | string |
Имя метаданных |
|
pattern
|
data3.pattern | string |
Шаблон метаданных |
|
options
|
data3.options | array of object |
options |
|
value
|
data3.options.value | string |
Значение метаданных |
|
type
|
data3.type | string |
type |
|
описание
|
data4.description | string |
Описание метаданных |
|
имя
|
data4.name | string |
Имя метаданных |
|
pattern
|
data4.pattern | string |
Шаблон метаданных |
|
options
|
data4.options | array of object |
options |
|
value
|
data4.options.value | string |
Значение метаданных |
|
type
|
data4.type | string |
type |
|
описание
|
data5.description | string |
Описание метаданных |
|
имя
|
data5.name | string |
Имя метаданных |
|
pattern
|
data5.pattern | string |
Шаблон метаданных |
|
options
|
data5.options | array of object |
options |
|
value
|
data5.options.value | string |
Значение метаданных |
|
type
|
data5.type | string |
type |
|
описание
|
data6.description | string |
Описание метаданных |
|
имя
|
data6.name | string |
Имя метаданных |
|
pattern
|
data6.pattern | string |
Шаблон метаданных |
|
options
|
data6.options | array of object |
options |
|
value
|
data6.options.value | string |
Значение метаданных |
|
type
|
data6.type | string |
type |
|
описание
|
data7.description | string |
Описание метаданных |
|
имя
|
data7.name | string |
Имя метаданных |
|
pattern
|
data7.pattern | string |
Шаблон метаданных |
|
options
|
data7.options | array of object |
options |
|
value
|
data7.options.value | string |
Метаданные |
|
type
|
data7.type | string |
type |
|
описание
|
data8.description | string |
Описание метаданных |
|
имя
|
data8.name | string |
Имя метаданных |
|
pattern
|
data8.pattern | string |
Шаблон метаданных |
|
options
|
data8.options | array of object |
options |
|
value
|
data8.options.value | string |
Значение метаданных |
|
type
|
data8.type | string |
type |
документ
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
создано
|
created | integer |
Дата создания |
|
groupId
|
groupId | string |
Идентификатор группы владельца документа |
|
id
|
id | string |
Идентификатор документа |
|
комплектующие
|
parts | array of part |
комплектующие |
|
pdfSignatureFields
|
pdfSignatureFields | array of pdfSigField |
pdfSignatureFields |
|
signatureProfileId
|
signatureProfileId | string |
Идентификатор профиля подписи документа |
|
tenantId
|
tenantId | string |
Идентификатор клиента |
|
Обновлено
|
updated | integer |
Дата последнего изменения |
|
userId
|
userId | string |
Идентификатор пользователя владельца документа |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Список групп, разрешенных для просмотра документа |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
Список пользователей, разрешенных для просмотра документа |
|
workflowId
|
workflowId | string |
Идентификатор рабочего процесса, к которому принадлежит документ |
|
workflowName
|
workflowName | string |
Имя рабочего процесса, к которому принадлежит документ |
Документы
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
items
|
items | array of document |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
общееКоличествоЭлементов
|
totalItems | integer |
общееКоличествоЭлементов |
мобильных приложений
Макет метаданных
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
создано
|
created | number |
Дата создания |
|
id
|
id | string |
Идентификатор макета |
|
isDisabled
|
isDisabled | boolean |
Если задано значение true, макет был разочаровывался |
|
имя
|
name | string |
Имя макета |
|
tenantId
|
tenantId | string |
Идентификатор клиента |
|
Обновлено
|
updated | number |
Дата последнего изменения |
|
dataConfigurations
|
dataConfigurations | array of object | |
|
щель
|
dataConfigurations.slot | string |
Элемент метаданных (data1 to data8) |
|
default
|
dataConfigurations.default | string |
Значение метаданных по умолчанию в этом макете |
|
optional
|
dataConfigurations.optional | boolean |
Если значение равно true, предоставление значения для этих метаданных не является обязательным |
|
Только для чтения
|
dataConfigurations.readonly | boolean |
Переопределение значения может быть переопределено |
|
rememberLastValue
|
dataConfigurations.rememberLastValue | boolean |
Если задано значение true, значение сохраняется в рабочих процессах. |
Макеты
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
items
|
items | array of object | |
|
создано
|
items.created | number |
Дата создания |
|
dataConfigurations
|
items.dataConfigurations | array of layout | |
|
itemsPerPage
|
itemsPerPage | number |
Количество элементов на странице |
|
pageIndex
|
pageIndex | number |
Индекс возвращаемой страницы |
|
общееКоличествоЭлементов
|
totalItems | number |
Общее количество элементов, обеспокоенных запросом |
part
Часть документа
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Тип контента
|
contentType | string |
Тип контента |
|
filename
|
filename | string |
filename |
|
hash
|
hash | string |
hash |
|
size
|
size | integer |
size |
pdfSigField
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
ImagePage
|
imagePage | float |
ImagePage |
|
imageWidth
|
imageWidth | float |
imageWidth |
|
imageX
|
imageX | float |
imageX |
|
imageY
|
imageY | float |
imageY |
signatureProfile
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
создано
|
created | number |
Дата создания |
|
documentType
|
documentType | string |
Тип документов |
|
forceScrollDocument
|
forceScrollDocument | boolean |
Принудительное прокрутка подписывющего элемента в нижней части документа |
|
id
|
id | string |
Идентификатор профиля подписи |
|
isDefault
|
isDefault | boolean |
Делает этот профиль подписи стандартным |
|
isDisabled
|
isDisabled | boolean |
Отключение этого профиля подписи |
|
имя
|
name | string |
Имя профиля подписи |
|
pdfSignatureImageText
|
pdfSignatureImageText | string |
Текст, отображаемый на сигнатурах |
|
pdfSignatureImageTextColor
|
pdfSignatureImageTextColor | string |
Цвет текста, отображаемого на полях с заготовками |
|
pdfSignatureImageTextSize
|
pdfSignatureImageTextSize | number |
Размер текста, отображаемого на полях с заготовками |
|
pdfVisibleSignatureMode
|
pdfVisibleSignatureMode | string |
Режим видимой подписи (разрешенный, отключенный, noImage) |
|
Тип подписи
|
signatureType | string |
pades, xades, xadesDetached, xadesDetachedManifest, cades, helios |
|
tenantId
|
tenantId | string |
Идентификатор арендатора |
|
Обновлено
|
updated | number |
Дата последнего изменения |
signatureProfiles
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
items
|
items | array of signatureProfile | |
|
itemsPerPage
|
itemsPerPage | number |
Количество элементов на странице |
|
pageIndex
|
pageIndex | number |
Индекс возвращаемой страницы |
|
общееКоличествоЭлементов
|
totalItems | number |
Общее количество элементов, обеспокоенных запросом |
Пользователь
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
утверждениеAllowed
|
approveAllowed | boolean |
Если задано значение true, пользователь может утвердить документы |
|
country
|
country | string |
Страна пользователя |
|
создано
|
created | integer |
Дата создания |
|
электронная почта
|
string |
Электронная почта пользователя |
|
|
Имя
|
firstName | string |
Имя пользователя |
|
groupId
|
groupId | string |
Идентификатор группы пользователя |
|
id
|
id | string |
ID пользователя |
|
isDisabled
|
isDisabled | boolean |
Если значение true, пользователь отключен |
|
lastLogin
|
lastLogin | integer |
Дата последнего входа пользователя |
|
lastName
|
lastName | string |
LastName пользователя |
|
имя
|
name | string |
Имя (имя и фамилия) пользователя |
|
organizationTitles
|
organizationTitles | array of |
Веселья пользователя в своих организациях |
|
номер телефона
|
phoneNumber | string |
Номер телефона пользователя |
|
signAllowed
|
signAllowed | boolean |
Если задано значение true, пользователь может подписать документы |
|
субъект
|
subject | string |
Внутренний код подкекта пользователя |
|
tenantId
|
tenantId | string |
Идентификатор клиента |
|
Обновлено
|
updated | integer |
Дата последнего изменения |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Список групп, в которых пользователь может выступать в качестве наблюдателя |
workflow
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
создано
|
created | integer |
создано |
|
currentRecipientEmails
|
currentRecipientEmails | array of |
currentRecipientEmails |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
data1
|
data1 | string |
Метаданные 1 |
|
data2
|
data2 | string |
Метаданные 2 |
|
data3
|
data3 | string |
Метаданные 3 |
|
data4
|
data4 | string |
Метаданные 4 |
|
data5
|
data5 | string |
Метаданные 5 |
|
data6
|
data6 | string |
Метаданные 6 |
|
data7
|
data7 | string |
Метаданные 7 |
|
data8
|
data8 | string |
Метаданные 8 |
|
описание
|
description | string |
Описание рабочего процесса |
|
электронная почта
|
string |
Электронная почта владельца рабочего процесса |
|
|
Имя
|
firstName | string |
Имя владельца рабочего процесса |
|
groupId
|
groupId | string |
Идентификатор группы владельца рабочего процесса |
|
id
|
id | string |
Идентификатор рабочего процесса |
|
lastName
|
lastName | string |
Фамилия владельца рабочего процесса |
|
LayoutId
|
layoutId | string |
Идентификатор макета метаданных рабочего процесса |
|
logs
|
logs | array of |
Журнал элементов wokflow |
|
имя
|
name | string |
Имя (имя и фамилия) владельца рабочего процесса |
|
уведомлениеEvents
|
notifiedEvents | array of string |
Сведения о событиях, уведомляемых рабочим процессом |
|
прогресс
|
progress | integer |
Ход выполнения рабочего процесса в процентах |
|
steps
|
steps | array of object |
steps |
|
allowComments
|
steps.allowComments | boolean |
Разрешить или запретить интерактивные комментарии, разрешенные на шаге |
|
hideAttachments
|
steps.hideAttachments | boolean |
Управляет отображением вложений для подписчиков |
|
hideWorkflowRecipients
|
steps.hideWorkflowRecipients | boolean |
Управляет отображением других подписывателей в подписыватель |
|
id
|
steps.id | string |
Идентификатор шага |
|
invitePeriod
|
steps.invitePeriod | integer |
invitePeriod |
|
IsFinished
|
steps.isFinished | boolean |
IsFinished |
|
запущен
|
steps.isStarted | boolean |
запущен |
|
logs
|
steps.logs | array of |
logs |
|
maxInvites
|
steps.maxInvites | integer |
maxInvites |
|
recipients
|
steps.recipients | array of object |
recipients |
|
consentPageId
|
steps.recipients.consentPageId | string |
consentPageId |
|
country
|
steps.recipients.country | string |
country |
|
электронная почта
|
steps.recipients.email | string |
электронная почта |
|
Имя
|
steps.recipients.firstName | string |
Имя |
|
lastName
|
steps.recipients.lastName | string |
lastName |
|
номер телефона
|
steps.recipients.phoneNumber | string |
номер телефона |
|
userId
|
steps.recipients.userId | string |
userId |
|
requiredRecipients
|
steps.requiredRecipients | integer |
requiredRecipients |
|
sendDownloadLink
|
steps.sendDownloadLink | boolean |
sendDownloadLink |
|
stepType
|
steps.stepType | string |
stepType |
|
validityPeriod
|
steps.validityPeriod | integer |
validityPeriod |
|
tenantId
|
tenantId | string |
tenantId |
|
Обновлено
|
updated | integer |
Обновлено |
|
userId
|
userId | string |
userId |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Список групп, в которых пользователи могут выступать в качестве наблюдателей |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
viewAuthorizedUsers |
|
watchers
|
watchers | array of object |
watchers |
|
электронная почта
|
watchers.email | string |
электронная почта |
|
уведомлениеEvents
|
watchers.notifiedEvents | array of string |
уведомлениеEvents |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
items
|
items | array of workflow |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
общееКоличествоЭлементов
|
totalItems | integer |
общееКоличествоЭлементов |
бинарный
Это базовый тип данных binary.