Документы Plumsail
Соединитель "Документы Plumsail" позволяет настроить автоматическое создание и преобразование документов. Соединитель предоставляет широкий спектр действий для управления PDF-документами и формами PDF. Создание документов из шаблонов, преобразование в PDF-файлы, разделение и слияние PDF-файлов, защита их, чтение форм PDF и многое другое — все, что необходимо для автоматизации документов в одном соединителе. Дополнительные сведения см. в https://plumsail.com/documents
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Support |
| URL | https://plumsail.com |
| Адрес электронной почты | support@plumsail.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Пламсайл |
| Веб-сайт | https://plumsail.com |
| Политика конфиденциальности | https://plumsail.com/privacy-policy/ |
| Категории | Продуктивность; Содержимое и файлы |
Создание документов в Microsoft Power Automate, Azure Logic Apps или PowerApps
Регистрация учетной записи
Прежде всего, необходимо зарегистрировать учетную запись Plumsail. Эта учетная запись используется для управления продуктами Plumsail Documents, Plumsail Actions и Plumsail Forms.
Лучше использовать активный адрес электронной почты. Подписка будет связана с этим адресом.
Если у вас уже есть учетная запись, просто войдите в account.plumsail.com.
Создание ключа API
Перейдите к разделу "Ключи API" и нажмите кнопку "Добавить новую".
После создания ключа API вы увидите ключ прямо в столбце "Секрет". Вы также можете изменить имя ключа, щелкнув его в столбце "Имя":
Создайте столько ключей, сколько вам нужно, например, для использования с разными учетными записями Power Automate (Microsoft Flow). Если ключ больше не нужен, его можно удалить, убедитесь, что ключ больше не используется.
Теперь вы можете скопировать и использовать его в:
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Доступный для общего пользования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API | securestring | Создание ключа API в account.plumsail.com | True |
| Расположение центра обработки данных | струна |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 1200 | 60 секунд |
Действия
Split PDF (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте split PDF .
Он принимает PDF-документ и разделяет его (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Необработанное содержимое PDF-документа |
|
Начальная страница
|
startPage | integer |
Первая страница для начала разделения (1 на основе) |
|
|
Конечная страница
|
endPage | integer |
Последняя страница для разделения (включительно) |
|
|
Разделение на странице
|
splitAtPage | integer |
Количество страниц на секцию |
|
|
Пароль
|
password | string |
Пароль для расшифровки документа |
Возвращаемое значение
Анализ CSV
Синтаксический анализ CSV работает так же, как Анализ JSON, но для CSV-файлов. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#parse-csv
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое CSV-документа
|
content | True | byte |
Содержимое CSV-документа |
|
Разделитель
|
delimiter | string |
Разделитель столбцов (по умолчанию это просто запятая) |
|
|
Региональные настройки
|
locale | string |
Языковой стандарт, который будет применен к документу |
|
|
Лимит
|
limit | integer |
Возвращает первые строки n |
|
|
Headers
|
headers | True | string |
Разделенный запятыми список заголовков в том же порядке, что и столбцы CSV |
|
Пропустить первую строку
|
skipFirstLine | boolean |
Выберите "Да", если в CSV-файле есть заголовки в качестве первой строки. |
Возвращаемое значение
Добавление водяного знака в PDF
Добавьте водяной знак в PDF в виде текста, изображения или PDF-файла. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#add-watermark-to-pdf
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип
|
type | True | string |
Тип водяного знака |
|
request
|
request | True | dynamic |
Возвращаемое значение
Замена регулярных выражений
Функция "Замена регулярных выражений" заменяет все строки, соответствующие шаблону регулярного выражения, указанной строкой замены в указанной входной строке. Мы рекомендуем использовать Regex Hero для тестирования выражений. Он поддерживает тот же синтаксис, что и действия. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-replace
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Рисунок
|
pattern | True | string |
Шаблон регулярного выражения |
|
Текст
|
text | True | string |
Строка для поиска совпадений |
|
Replacement
|
replacement | string |
Строка замены |
Возвращаемое значение
- Тело
- StringResultResponse
Заполнение PDF-формы
Заполнение PDF-формы заполняется по предоставленным данным. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-in-pdf-form
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Необработанное содержимое PDF-документа |
|
Данные JSON
|
jsonData | True | object |
Данные, которые будут использоваться для заполнения формы |
|
Блокировка полей формы
|
lockFormFields | boolean |
Отключение редактирования полей после заполнения |
|
|
Пароль
|
password | string |
Пароль для открытия PDF-файла |
Возвращаемое значение
Заполнение полей слияния в документе DOCX
Заполнение полей слияния в документе DOCX принимает документ DOCX с полями слияния и заменяет их указанными данными. Ключи в объекте данных должны совпадать с именами блоков MergeFields (express) в документе. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-merge-fields-in-docx-document
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа DOCX
|
docxDocument | True | byte |
Необработанное содержимое шаблона документа docx. Имена MergeField должны совпадать с ключами в данных шаблона |
|
Данные шаблона
|
data | True | object |
Данные JSON, которые должны применяться к шаблону |
Возвращаемое значение
Запуск процесса создания документов
Процесс создания документов заполняет шаблон DOCX, XLSX, PPTX или PDF, связанный с выбранным процессом с данными JSON. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#start-document-generation-process
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя процесса
|
processId | True | string |
Имя запускаемого процесса |
|
данные
|
data | True | dynamic |
Возвращаемое значение
- Файл результатов
- binary
Запуск процесса создания документов с помощью json
Процесс создания документов заполняет шаблон DOCX, XLSX, PPTX или PDF, связанный с выбранным процессом с данными JSON. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html##start-process-json
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя процесса
|
processId | True | string |
Имя запускаемого процесса |
|
|
object |
Возвращаемое значение
- Файл результатов
- binary
Защита PDF-документа
Защита PDF-документа добавляет пароли, копирование, печать и другие средства защиты в PDF-файлы. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#protect-pdf-document
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Необработанное содержимое PDF-документа |
|
Включить печать
|
allowPrinting | True | boolean |
Защита PDF-файла от печати |
|
Включение изменения
|
allowModification | True | boolean |
Защита PDF-файла от редактирования |
|
Включение извлечения данных
|
allowExtract | True | boolean |
Разрешает извлечение текста, изображений и других носителей из PDF-файла |
|
Включение аннотации
|
allowAnnotate | True | boolean |
Разрешает заметку (например, примечания, заполнение формы, подпись) PDF-файла |
|
Пароль владельца PDF
|
newOwnerPassword | string |
Введите здесь необязательный пароль владельца. Этот пароль можно использовать для отключения ограничений документов |
|
|
Пароль пользователя PDF
|
newUserPassword | string |
Введите необязательный пароль пользователя здесь. Каждый раз, когда пользователь открывает PDF-файл, он будет запрашивать этот пароль. Если запрос на пароль не требуется, оставьте это поле пустым |
|
|
Пароль
|
password | string |
Пароль для расшифровки документа |
Возвращаемое значение
Извлечение архива
Извлеките файлы из архива.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
файл Архив
|
fileContent | byte |
Содержимое архивного файла |
|
|
Включить папки
|
includeFolders | boolean |
Если файлы true, содержащиеся в папках, будут извлечены |
|
|
Пароль
|
password | string |
Архив пароля |
Возвращаемое значение
Извлечение текста из PDF-документа
Извлечение текста из PDF-файла принимает PDF-документ и извлекает текст в формат Raw или HTML. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#extract-text-from-pdf-document
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Необработанное содержимое PDF-документа |
|
Начальная страница
|
startPage | integer |
Первая страница для запуска извлечения (на основе 1) |
|
|
Конечная страница
|
endPage | integer |
Последняя страница для извлечения (включительно) |
|
|
Тип результата
|
resultType | string |
Необработанные или HTML-коды |
|
|
Пароль
|
password | string |
Пароль для расшифровки документа |
Возвращаемое значение
Получение сведений о защите PDF
Получение сведений о защите PDF возвращает сведения о том, защищен ли документ паролем. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-pdf-protection-information
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Необработанное содержимое PDF-документа |
Возвращаемое значение
Получение сведений о профиле
Получение сведений о профиле возвращает сведения о текущем пользователе и лицензии.
Возвращаемое значение
- Тело
- ProfileInfo
Получение формы из PDF
Получение формы из PDF возвращает заполненные данные формы из PDF-файла в формате JSON. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-form-from-pdf
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Необработанное содержимое PDF-документа |
|
Пароль
|
password | string |
Пароль для расшифровки документа |
Возвращаемое значение
- response
- object
Преобразование CSV в Excel
Преобразование CSV-файла в Excel (XLSX). Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#csv-to-excel
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое CSV-документа
|
content | True | byte |
Содержимое CSV-документа |
|
Разделитель
|
delimiter | string |
Разделитель столбцов (по умолчанию это просто запятая) |
|
|
Региональные настройки
|
locale | string |
Языковой стандарт, который будет применен к документу |
|
|
Лимит
|
limit | integer |
Возвращает первые строки n |
|
|
Использование первой строки в качестве заголовков
|
hasHeaderRecords | boolean |
Если задано значение "Да", заголовки будут считываться из первой строки. |
|
|
Имя или индекс столбца CSV
|
csvColumnIndexOrName | True | string |
Имя столбца CSV или индекс столбца (1, 2 и т. д.) |
|
Тип столбца XLSX
|
xlsxColumnType | string |
Необязательно. Тип столбца (ShortDateTime, TwoDecimal и т. д.) |
|
|
Имя столбца XLSX
|
xlsxColumnName | string |
Необязательно. Переименование столбца CSV в это имя |
Возвращаемое значение
- Файл результатов
- binary
Преобразование DOC в DOCX
Преобразование DOC в ФАЙЛЫ DOCX. Это действие принимает документ DOC и преобразует его в DOCX. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-doc-to-docx
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Содержимое документа, которое должно быть преобразовано |
Возвращаемое значение
- Файл результатов
- binary
Преобразование DOCX в PDF
Преобразование DOCX в PDF-файлы. Это действие принимает документ DOCX и преобразует его в PDF. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-docx-to-pdf
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Содержимое документа, которое должно быть преобразовано |
Возвращаемое значение
Преобразование HTML в DOCX
Преобразование HTML в документ DOCX. Это действие выполняет разметку HTML, отрисовывает ее и преобразует в документ DOCX. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-html-to-docx
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое файла
|
fileContent | binary |
Двоичное содержимое HTML-файла для преобразования в DOCX |
|
|
HTML-данные
|
rawHtml | string |
HTML-данные для преобразования в DOCX |
|
|
URL-адрес HTML
|
htmlUrl | string |
URL-адрес веб-страницы для преобразования в DOCX |
|
|
Размер бумаги
|
paperSize | string |
Может быть A4,A5 и т. д. |
|
|
Ориентация
|
orientation | string |
Книжный или альбомный |
|
|
Декодирование HTML
|
decodeHtml | boolean |
Следует ли декодировать HTML перед преобразованием |
|
|
Поля
|
margins | string |
Поля страницы в pt. Синтаксис совпадает с синтаксисом в CSS. Пример: 25 50 75 100. |
Возвращаемое значение
Преобразование HTML в PDF
Преобразование HTML-файла в PDF-файл. Это действие выполняет разметку HTML, отрисовывает ее и преобразует в PDF-документ. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-html-to-pdf
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Исходный HTML
|
html | True | string |
Разметка HTML, которая должна быть преобразована в PDF |
|
Engine
|
engine | string |
Подсистема преобразования |
|
|
Размер бумаги
|
size | string |
Может быть A4,A5 и т. д. |
|
|
Ориентация
|
orientation | string |
Книжный или альбомный |
|
|
Поля
|
margins | string |
Поля страницы. Синтаксис совпадает с синтаксисом в CSS. Пример: 25 50 75 100. |
|
|
HTML-код заголовка
|
headerHtml | string |
Разметка HTML, которая должна быть добавлена в качестве заголовка |
|
|
HTML-код нижнего колонтитула
|
footerHtml | string |
Разметка HTML, которую следует добавить в качестве нижнего колонтитула |
Возвращаемое значение
Преобразование JSON в CSV
Преобразование JSON в CSV-файл. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#json-to-csv
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое файла JSON
|
content | byte |
Необязательно. Содержимое JSON-файла |
|
|
Данные JSON
|
jsonData | string |
Необязательно. Данные JSON для обработки |
|
|
Региональные настройки
|
locale | string |
Языковой стандарт, который будет применен к документу |
|
|
Путь к массиву JSON
|
pathToJsonArray | string |
Разделенный точкой путь к массиву в ФОРМАТЕ JSON. Например, "data" или "prop1.prop2.prop3" |
|
|
Разделитель
|
delimiter | string |
Разделитель столбцов в CSV. По умолчанию используется запятая |
Возвращаемое значение
- Файл результатов
- binary
Преобразование JSON в Excel
Преобразование JSON в файл Excel (XLSX). Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#json-to-excel
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое файла JSON
|
content | byte |
Необязательно. Содержимое JSON-файла |
|
|
Данные JSON
|
jsonData | string |
Необязательно. Данные JSON для обработки |
|
|
Региональные настройки
|
locale | string |
Языковой стандарт, который будет применен к документу |
|
|
Путь к массиву JSON
|
pathToJsonArray | string |
Разделенный точкой путь к массиву в ФОРМАТЕ JSON. Например, "data" или "prop1.prop2.prop3" |
|
|
Свойство JSON
|
jsonProperty | True | string |
Имя свойства JSON |
|
Тип столбца XLSX
|
xlsxColumnType | string |
Необязательно. Тип столбца (ShortDateTime, TwoDecimal и т. д.) |
|
|
Имя столбца XLSX
|
xlsxColumnName | string |
Необязательно. Переименование свойства JSON в это имя |
Возвращаемое значение
- Файл результатов
- binary
Преобразование PDF-файла в изображение
Преобразование PDF-файла в изображение. Это действие принимает PDF-документ и преобразует его в изображение (jpeg, png, gif, bmp и т. д.). Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pdf-to-image
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Необработанное содержимое PDF-документа |
|
Префикс имени файла
|
filenamePrefix | string |
Необязательно. Выходные файлы будут иметь этот префикс, за которым следует номер индекса для имени |
|
|
Начальная страница
|
startPage | integer |
Первая страница для запуска извлечения (на основе 1) |
|
|
Конечная страница
|
endPage | integer |
Последняя страница для извлечения (включительно) |
|
|
Страницы
|
pages | string |
Номера страниц для извлечения, разделенные ";" (только эти страницы будут извлечены) |
|
|
Формат изображения
|
format | string |
Формат изображения результата |
|
|
DPI
|
dpi | integer |
Разрешение изображения результата |
|
|
Пароль
|
password | string |
Пароль для расшифровки документа |
Возвращаемое значение
Преобразование PDF-файла в изображение (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте преобразование PDF-файла в изображение .
Преобразование PDF-файла в изображение. Это действие принимает PDF-документ и преобразует его в изображение (jpeg, png, gif, bmp и т. д.). Документация — https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pdf-to-image (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Необработанное содержимое PDF-документа |
|
Начальная страница
|
startPage | integer |
Первая страница для запуска извлечения (на основе 1) |
|
|
Конечная страница
|
endPage | integer |
Последняя страница для извлечения (включительно) |
|
|
Страницы
|
pages | string |
Номера страниц для извлечения, разделенные ";" (только эти страницы будут извлечены) |
|
|
Формат изображения
|
format | string |
Формат изображения результата |
|
|
DPI
|
dpi | integer |
Разрешение изображения результата |
|
|
Пароль
|
password | string |
Пароль для расшифровки документа |
Возвращаемое значение
Преобразование PPT в PPTX
Преобразование PPT в PPTX-файлы. Это действие принимает документ PPT и преобразует его в PPTX. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-ppt-to-pptx
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Содержимое документа, которое должно быть преобразовано |
Возвращаемое значение
- Файл результатов
- binary
Преобразование PPTX в PDF
Преобразование PPTX в PDF-файлы. Это действие принимает документ PPTX и преобразует его в PDF. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pptx-to-pdf
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Содержимое документа, которое должно быть преобразовано |
Возвращаемое значение
- Файл результатов
- binary
Преобразование XLS в XLSX
Преобразуйте XLS-файлы в XLSX-файлы. Это действие принимает документ XLS и преобразует его в XLSX. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xls-to-xlsx
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Содержимое документа, которое должно быть преобразовано |
Возвращаемое значение
- Файл результатов
- binary
Преобразование XLSX в PDF
Преобразование XLSX в PDF-файлы. Это действие принимает документ XLSX и преобразует его в PDF. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xlsx-to-pdf
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Содержимое документа, которое должно быть преобразовано |
Возвращаемое значение
- Файл результатов
- binary
Преобразование в PDF
Преобразуйте предоставленный файл в PDF-файл. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-to-pdf
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Содержимое документа, которое должно быть преобразовано |
|
Filename
|
filename | True | string |
Полное имя преобразованного файла. Включение расширения файла |
Возвращаемое значение
- Файл результатов
- binary
Преобразование изображений в PDF
Он принимает изображения и преобразует их в PDF-документ
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Один образ на страницу
|
imagePerPage | boolean |
Выберите "Нет", если вы не хотите, чтобы каждое изображение было на отдельной странице. Значение по умолчанию — "Да" |
|
|
Содержимое изображения
|
imageContent | True | array of byte |
Необработанное содержимое изображения |
Возвращаемое значение
- Файл результатов
- binary
Преобразование электронной почты в PDF
Преобразование предоставленного сообщения электронной почты в PDF-файл. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-email-to-pdf
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое сообщения электронной почты
|
documentContent | True | byte |
Содержимое сообщения электронной почты, которое должно быть преобразовано |
|
Слияние вложений
|
mergeAttachments | True | boolean |
Следует ли преобразовать вложения в PDF и включить в выходной файл |
Возвращаемое значение
- Файл результатов
- binary
Проверка регулярных выражений
Проверка регулярных выражений указывает, находит ли регулярное выражение, указанное в конструкторе Regex, совпадение в указанной входной строке. Мы рекомендуем использовать Regex Hero для тестирования выражений. Он поддерживает тот же синтаксис, что и действия. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-test
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Рисунок
|
pattern | True | string |
Шаблон регулярного выражения |
|
Текст
|
text | True | string |
Строка для поиска совпадений |
Возвращаемое значение
Разделение PDF
Разделение PDF-файла принимает PDF-документ и разделяет его. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#split-pdf
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип разделения
|
type | True | string |
Разделение файла |
|
request
|
request | True | dynamic |
Возвращаемое значение
Сжатие PDF-документа
При возможности сжимайте размер документа PDF и оптимизируйте его. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#compress-pdf-document
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Содержимое документа
|
documentContent | True | byte |
Необработанное содержимое PDF-документа |
|
Режим без потери
|
losslessMode | string |
При отключении сжимает PDF-файл более эффективно, но с небольшой потерей качества изображения. |
|
|
Пароль
|
password | string |
Пароль для открытия PDF-файла |
Возвращаемое значение
- Файл результатов
- binary
Слияние PDF (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте слияние всех файлов в PDF .
Слияние PDF принимает массив ДОКУМЕНТОВ PDF и объединяет его в один. Документация — https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-pdf (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Content
|
documentsContents | True | array of binary |
Массив необработанного содержимого ДОКУМЕНТОВ PDF |
Возвращаемое значение
- Файл результатов
- binary
Слияние XLSX-файлов
Слияние XLSX-файлов принимает массив документов Xlsx и объединяет его в один файл. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-xlsx-files
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Content
|
documentsContents | True | array of binary |
Массив необработанного содержимого документов Xlsx |
Возвращаемое значение
Слияние всех файлов в PDF
Преобразование и слияние нескольких файлов в один PDF-документ. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-any-files-into-pdf
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Filename
|
fileName | True | string |
Имя файла, включая расширение |
|
Содержимое файла
|
content | True | binary |
Содержимое файла |
|
Создание закладок
|
generateBookmarks | boolean |
Создание закладки для каждого объединенного файла |
|
|
Сохранение закладок
|
preserveBookmarks | boolean |
Сохранение закладок из каждого объединенного PDF-файла |
Возвращаемое значение
- Файл результатов
- binary
Слияние ФАЙЛОВ DOCX
Слияние файлов DOCX принимает массив документов Docx и объединяет его в один файл. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-docx-files
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Content
|
documentsContents | True | array of binary |
Массив необработанного содержимого документов Docx |
|
Применение верхнего и нижнего колонтитула
|
applyHeaderAndFooter | True | boolean |
Применяет верхний и нижний колонтитул из первого документа ко всем остальным |
Возвращаемое значение
Совпадение регулярных выражений
Совпадение регулярных выражений выполняет поиск входной строки для всех вхождения регулярного выражения и возвращает все совпадения. Мы рекомендуем использовать Regex Hero для тестирования выражений. Он поддерживает тот же синтаксис, что и действия. Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-match
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Рисунок
|
pattern | True | string |
Шаблон регулярного выражения |
|
Текст
|
text | True | string |
Строка для поиска совпадений |
Возвращаемое значение
Создание HTML из шаблона
Создание HTML принимает входную строку шаблона HTML или файл и заменяет специальные {{Token}} указанными данными. Мы используем платформу Mustache для шаблонов внутри. Дополнительные сведения о шаблонах в документах mustache: http://mustache.github.io/mustache.5.html Документация- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#create-html-from-template
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Исходный HTML
|
html | True | byte |
Текстовый шаблон HTML или шаблон HTML-файла |
|
Данные шаблона
|
data | True | object |
Данные JSON, которые должны применяться к шаблону |
|
Региональные настройки
|
locale | string |
Языковой стандарт, который будет применен к документу |
|
|
Часовой пояс
|
timezone | string |
Часовой пояс документа |
Возвращаемое значение
Создание архива
Сжимает и добавляет файлы в ZIP-архив.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя файла
|
fileName | True | string |
Имя архива без расширения файла |
|
Имя файла
|
fileName | string |
Имя файла, включая расширение файла |
|
|
Содержимое файла
|
content | binary |
Содержимое документа |
|
|
Пароль
|
password | string |
Архив пароля |
Возвращаемое значение
Создание документа из шаблона DOCX
Создайте документ из шаблона DOCX. Дополнительные сведения: https://plumsail.com/docs/documents/v1.x/document-generation/docx/index.html
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Файл шаблона
|
documentContent | True | binary |
Содержимое шаблона |
|
Данные шаблона
|
data | True | object |
Данные JSON, которые должны применяться к шаблону |
|
Тип выходных данных документа
|
outputType | True | string |
Обязательный тип документа |
|
Региональные настройки
|
locale | string |
Языковой стандарт, который будет применен к документу |
|
|
Часовой пояс
|
timezone | string |
Часовой пояс документа |
|
|
Подсистема шаблонов
|
engine | string |
Обработчик, обрабатывающий шаблон |
Возвращаемое значение
- Файл результатов
- binary
Создание документа из шаблона PPTX
Создайте документ из шаблона PPTX. Дополнительные сведения: https://plumsail.com/docs/documents/v1.x/document-generation/pptx/index.html
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Файл шаблона
|
documentContent | True | binary |
Содержимое шаблона |
|
Данные шаблона
|
data | True | object |
Данные JSON, которые должны применяться к шаблону |
|
Тип выходных данных документа
|
outputType | True | string |
Обязательный тип документа |
|
Региональные настройки
|
locale | string |
Языковой стандарт, который будет применен к документу |
|
|
Часовой пояс
|
timezone | string |
Часовой пояс документа |
Возвращаемое значение
Создание документа из шаблона XLSX
Создайте документ из шаблона XLSX. Дополнительные сведения: https://plumsail.com/docs/documents/v1.x/document-generation/xlsx/index.html
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Файл шаблона
|
documentContent | True | binary |
Содержимое шаблона |
|
Данные шаблона
|
data | True | object |
Данные JSON, которые должны применяться к шаблону |
|
Тип выходных данных документа
|
outputType | True | string |
Обязательный тип документа |
|
Региональные настройки
|
locale | string |
Языковой стандарт, который будет применен к документу |
|
|
Часовой пояс
|
timezone | string |
Часовой пояс документа |
Возвращаемое значение
- Файл результатов
- binary
Триггеры
| Процесс завершен |
Создает веб-перехватчик, который выполняется после завершения процесса |
Процесс завершен
Создает веб-перехватчик, который выполняется после завершения процесса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя процесса
|
processId | True | string |
Имя процесса, который, когда закончится, активирует поток |
Возвращаемое значение
Определения
ApplyHtmlTemplateResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Html-код результата
|
htmlResult | string |
Необработанный результат HTML |
BooleanResultResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
IsSuccess
|
isSuccess | boolean |
DocumentContentWithFilenameResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Filename
|
filename | string |
Имя файла |
|
Содержимое файла
|
fileContent | byte |
Содержимое файла |
DocumentProcessingResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Файл результатов
|
fileContent | byte |
Результат в виде файла |
DocumentsArrayResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Файлы результатов
|
resultFilesContents | array of byte |
Массив необработанного содержимого файлов результатов |
DocumentsWithFilenamesResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Файлы результатов
|
resultFiles | array of DocumentContentWithFilenameResponse |
Массив необработанного содержимого файлов результатов с именами файлов |
GetPdfProtectionInfoResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
isPasswordProtected
|
isPasswordProtected | boolean |
LicenseInfo
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
type
|
type | integer | |
|
credits
|
credits | integer | |
|
дополнительные кредиты
|
additionalCredits | integer | |
|
дата окончания срока действия
|
expirationDate | date-time |
ProfileInfo
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string | |
|
электронная почта
|
string | ||
|
licenseStatus
|
licenseStatus | string | |
|
teamName
|
teamName | string | |
|
licenseInfo
|
licenseInfo | LicenseInfo | |
|
shortUserId
|
shortUserId | string |
StringResultResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Result
|
result | string |
бинарный
Это базовый тип данных binary.
объект
Это тип object.