Encodian [已弃用]

增强的文档格式转换,OCR,水印,数据提取,修订 + 更多。

此连接器在以下产品和区域中可用:

服务 Class 区域
Copilot Studio 标准 除以下各项外的所有 Power Automate 区域
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域
     - Azure 中国区域
     - 美国国防部(DoD)
Power Apps 标准 除以下各项外的所有 Power Apps 区域
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
Power Automate 标准 除以下各项外的所有 Power Automate 区域
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
联系人​​
Name Encodian 支持
URL https://support.encodian.com
Email support@encodian.com
连接器元数据
发布者 Encodian
网站 https://www.encodian.com
隐私策略 https://support.encodian.com/hc/en-gb/articles/360010885513-Privacy-Policy
类别 内容和文件;协作

适用于 Microsoft Power Automate 的 Encodian”连接器提供企业级和易于使用的 Flow作,这些作提供广泛的文档和以图像为中心的功能,文档格式转换、文档合并和拆分、水印、OCR、区域数据提取、PDF 表单数据提取和填充、图像和文本层提取、HTML 转换、CSV 分析、正则表达式搜索、文档安全性、ZIP 文件创建、文档修订、图像清理、图像压缩和调整大小、图像格式转换、条形码创建和阅读等。

先决条件

使用 Encodian Power Automate 连接器需要 Encodian 订阅。

访问 https://www.encodian.com/pricing 订阅计划详细信息。

如何入门

访问 https://www.encodian.com/apikey 以注册 30 天试用版并获取即时访问权限

30 天试用版到期后,除非已购买付费计划,否则 Encodian 订阅将自动转换为 Encodian 的免费订阅计划。

单击此处获取有关如何在 Power Automate 中创建 Encodian 连接的分步指南

请联系 Encodian 支持 部门请求帮助

Encodian作文档位于此处,可在此处找到示例流

正在创建连接

连接器支持以下身份验证类型:

默认 用于创建连接的参数。 所有区域 可共享

违约

适用:所有区域

用于创建连接的参数。

这是可共享的连接。 如果 Power App 与其他用户共享,则连接也会共享。 有关详细信息,请参阅 画布应用的连接器概述 - Power Apps |Microsoft Docs

Name 类型 Description 必选
API 密钥 securestring 获取 API 密钥 - https://www.encodian.com/apikey/ True
区域 字符串

限制

名称 调用 续订期
每个连接的 API 调用数 600 60 秒

操作

OCR PDF 文档 [已弃用]

对现有 PDF 文档执行 OCR (已弃用)

Redact PDF [已弃用]

将指定的修订应用于提供的 PDF 文档(已弃用)

从 Excel 中删除行 [已弃用]

从提供的 Excel 文件中删除行(已弃用)

从 Excel 获取行 [已弃用]

从提供的 Excel 文件获取行(已弃用)

从 PDF 中删除水印 [已弃用]

从提供的 PDF 文档中删除指定的水印(已弃用)

从 PDF 中提取图像 [已弃用]

使用指定区域从 PDF 中提取图像(已弃用)

从 PDF 中提取附件 [已弃用]

从提供的 PDF 中提取附件(已弃用)

从 Word 中删除水印 [已弃用]

从提供的 Word 文件中删除水印(已弃用)

从 Word 获取文本 [已弃用]

获取提供的 Microsoft Word 文件中包含的文本(已弃用)

从区域提取文本 [已弃用]

使用指定的区域从 70 多个文件类型使用 OCR 提取文本(已弃用)

从图像中提取文本 [已弃用]

从提供的图像中提取文本(已弃用)

从存档中提取 [已弃用]

从提供的存档中提取文件(已弃用)

从映像中删除 EXIF 标记 [已弃用]

从指定的映像中删除 EXIF 标记(已弃用)

修复 PDF [已弃用]

修复 PDF 文档 (已弃用)

分析 CSV [已弃用]

分析 CSV 并返回 JSON 格式提取的数据(已弃用)

创建 QR 代码 [已弃用]

使用指定的图像格式创建 QR 码(已弃用)

创建条形码 [已弃用]

使用指定的图像格式创建条形码(已弃用)

压缩 PDF [已弃用]

压缩和优化 PDF 文档(已弃用)

压缩 PowerPoint [已弃用]

压缩提供的 PowerPoint 文件(已弃用)

压缩映像 [已弃用]

压缩提供的映像(已弃用)

发送到 Encodian Filer [已弃用]

将数据发送到 Encodian Filer 终结点(已弃用)

合并 Excel 文件 [已弃用]

将Microsoft Excel 文件的数组合并到单个文件(已弃用)

合并 Excel 行 [已弃用]

将 Excel 文件中包含的行合并到单个工作表中(已弃用)

合并 Word 文档 [已弃用]

将 Microsoft Word 文档的数组合并到单个Microsoft Word 文档(已弃用)

合并演示文稿 [已弃用]

将演示文稿数组合并到单个演示文稿(已弃用)

向 Word 添加文本水印 [已弃用]

将文本水印添加到指定的Microsoft Word 文档(已弃用)

向图像添加文本水印 [已弃用]

向提供的图像添加文本水印(已弃用)

启用修订 [已弃用]

对提供的 Microsoft Word 文档启用修订(已弃用)

图像清理 - 照片 [已弃用]

执行标准照片图像的图像清理活动(已弃用)

填充 Excel [已弃用]

使用提供的 JSON 数据填充Microsoft Excel 工作簿(XLSX)

填充 PowerPoint [已弃用]

使用提供的 JSON 数据填充Microsoft PowerPoint 文件(PPTX)

填充 Word 文档 [已弃用]

使用提供的 JSON 数据填充Microsoft Word 文档(DOCX)(已弃用)

填写 PDF 表单 [已弃用]

使用提供的 JSON 数据填充 PDF 表单(已弃用)

安全 PDF 文档 [已弃用]

加密和保护 PDF 文档(已弃用)

安全 Word 文档 [已弃用]

保护和保护Microsoft Word 文档(已弃用)

实用工具 - AES 加密 [已弃用]

使用 AES 加密(已弃用)加密纯文本值(字符串)

实用工具 - AES 解密 [已弃用]

使用 AES 解密对 AES 加密的字符串进行解密 (已弃用)

实用工具 - Unescape HTML [已弃用]

取消设置提供的 HTML 值(已弃用)

实用工具 - 从文本中提取 URL [已弃用]

从提供的文本值中提取 URL (已弃用)

实用工具 - 从文本中提取电子邮件地址 [已弃用]

从提供的文本值中提取电子邮件地址(已弃用)

实用工具 - 使用正则表达式搜索文本 [已弃用]

使用提供的正则表达式搜索提供的文本以查找匹配项(已弃用)

实用工具 - 分析 HTML 表 [已弃用]

分析提供给 JSON 的 HTML 中包含的表(已弃用)

实用工具 - 创建 GUID [已弃用]

生成新的 GUID (已弃用)

实用工具 - 创建 HMAC [已弃用]

使用密钥创建基于哈希的消息身份验证代码(HMAC)(已弃用)

实用工具 - 创建哈希代码 [已弃用]

为提供的字符串创建哈希代码(已弃用)

实用工具 - 删除值之间的文本 [已弃用]

从提供的两个值之间删除字符串中的文本(已弃用)

实用工具 - 删除音调符号 [已弃用]

从提供的文本中删除音调符号(已弃用)

实用工具 - 剪裁文本 [已弃用]

剪裁提供给集配置的文本值(已弃用)

实用工具 - 将值替换为文本 [已弃用]

替换提供的文本中的值(已弃用)

实用工具 - 将值替换为正则表达式 [已弃用]

替换使用正则表达式查询提供的文本中的值(已弃用)

实用工具 - 拆分文本 [已弃用]

使用集分隔符拆分提供的文本(已弃用)

实用工具 - 提取值之间的文本 [已弃用]

从提供的两个值之间的字符串中提取文本(已弃用)

实用工具 - 提取值之间的文本实例 [已弃用]

从提供的两个值之间的字符串中提取所有文本实例(已弃用)

实用工具 - 数组删除重复项 [已弃用]

从提供的数组中删除重复项(已弃用)

实用工具 - 数组删除项 [已弃用]

从提供的数组中删除一个或多个项(已弃用)

实用工具 - 数组到 JSON [已弃用]

将数组转换为命名 JSON 对象(已弃用)

实用工具 - 数组包含值 [已弃用]

检查是否包含在提供的数组中(已弃用)

实用工具 - 数组反向项 [已弃用]

反转提供的 JSON 数组中的项(已弃用)

实用工具 - 数组替换值 [已弃用]

将数组或指定项替换为提供的值(已弃用)

实用工具 - 数组添加项 [已弃用]

将一个或多个项添加到提供的数组(已弃用)

实用工具 - 数组获取项 [已弃用]

从提供的 JSON 数组(s)获取指定的项(已弃用)

实用工具 - 数组计数项 [已弃用]

对提供的数组中包含的项进行计数(已弃用)

实用工具 - 文本包含值 [已弃用]

检查提供的文本值是否包含指定的文本值(已弃用)

实用工具 - 格式日期 [已弃用]

将日期值格式化为所选格式配置(已弃用)

实用工具 - 比较文本 [已弃用]

比较提供的文本值(已弃用)

实用工具 - 清理文本 [已弃用]

从提供的文本值中删除无效或指定的字符(已弃用)

实用工具 - 生成密码 [已弃用]

创建符合指定配置的密码(已弃用)

实用工具 - 生成随机数 [已弃用]

生成符合提供的配置的随机数(已弃用)

实用工具 - 获取文件扩展名 [已弃用]

获取提供的 filaname 的文件扩展名(已弃用)

实用工具 - 获取日期和时间差异 [已弃用]

计算两个日期和时间之间的差异(已弃用)

实用工具 - 计算日期 [已弃用]

通过添加或减去给定时间段来计算日期值(已弃用)

实用工具 - 设置文本大小写的格式 [已弃用]

设置提供的文本(字符串)大小写(已弃用)

实用工具 - 转义 HTML [已弃用]

转义提供的 HTML 值(已弃用)

实用工具 - 转换时区 [已弃用]

将提供的日期和时间值转换为另一个时区(已弃用)

实用工具 - 连接文本 [已弃用]

连接提供的文本值(已弃用)

实用工具 - 通过正则表达式删除项的数组 [已弃用]

使用正则表达式从 JSON 数组中删除项(已弃用)

实用工具 - 验证 GUID [已弃用]

验证提供的 GUID 是否有效(已弃用)

实用工具 - 验证 JSON [已弃用]

根据集架构(已弃用)验证提供的 JSON 数据(可选)

实用工具 - 验证 URL 可用性 [已弃用]

验证提供的 URL 是否可用(已弃用)

实用工具 - 验证 URL 语法 [已弃用]

验证提供的 URL 是否具有有效的语法(已弃用)

实用工具 - 验证电子邮件地址 [已弃用]

验证提供的电子邮件地址(已弃用)

将 HTML 插入 PDF [已弃用]

将提供的 HTML 插入 PDF 文档(已弃用)

将 HTML 转换为 PDF [已弃用]

将提供的 HTML 或 Web URL 转换为 PDF 文档(已弃用)

将 HTML 转换为 Word [已弃用]

将提供的 HTML 或 Web URL 转换为 Microsoft Word 文档(已弃用)

将 HTML 页眉或页脚添加到 PDF [已弃用]

将 HTML 页眉、页脚或两者添加到指定的 PDF 文档(已弃用)

将 JSON 转换为 Excel [已弃用]

将 JSON 转换为 Microsft Excel 文件(已弃用)

将 PDF 转换为 JPG [已弃用]

将 PDF 文档转换为 JPG (已弃用)

将 PDF 转换为 PDFA [已弃用]

将 PDF 文档转换为 PDF/A 格式(已弃用)

将 PDF 转换为 PNG [已弃用]

将 PDF 文档转换为 PNG (已弃用)

将 PDF 转换为 TIFF [已弃用]

将 PDF 文档转换为 TIFF (tiff) 格式(已弃用)

将 PDF 转换为 Word [已弃用]

将 PDF 文档转换为 Microsoft Word (docx) 格式(已弃用)

将 PDF 转换为图像 [已弃用]

将 PDF 文档转换为图像数组(PNG 或 JPG)(已弃用)

将 Word 转换为 PDF 表单 [已弃用]

将提供的 Word 文档(仅旧窗体控件)转换为 PDF 窗体文档(已弃用)

将图像水印添加到 PDF - 高级 [已弃用]

使用标准选项将图像水印添加到指定的 PDF 文档(已弃用)

将图像水印添加到 PDF [已弃用]

使用标准选项将图像水印添加到指定的 PDF 文档(已弃用)

将图像水印添加到 Word [已弃用]

将图像水印添加到指定的 word 文档Microsoft(已弃用)

将图像水印添加到图像 [已弃用]

将图像水印添加到提供的映像(已弃用)

将文本替换为图像 [已弃用]

使用图像查找和替换 PDF 或 DOCX 文档中包含的文本(已弃用)

将文本水印添加到 PDF - 高级 [已弃用]

使用高级选项将文本水印添加到指定的 PDF 文档(已弃用)

将文本水印添加到 PDF [已弃用]

使用标准选项将文本水印添加到指定的 PDF 文档(已弃用)

将文本转换为 PDF [已弃用]

将提供的文本转换为 PDF 文档(已弃用)

将文档合并到 PDF [已弃用]

转换和合并提供给单个 PDF 文档的文档(已弃用)

将文档数组合并到 PDF [已弃用]

将文档数组转换为单个 PDF 文档(已弃用)

将行添加到 Excel [已弃用]

将行添加到提供的 Excel 文件(已弃用)

将附件添加到 PDF [已弃用]

将一个或多个附件添加到提供的 PDF 文件(已弃用)

平展 PDF [已弃用]

平展 PDF 文档或 PDF 表单(已弃用)

拆分 PDF [已弃用]

将 PDF 文档拆分为多个 PDF 文档(已弃用)

按文本拆分 PDF [已弃用]

将 PDF 文档按文本拆分为多个 PDF 文档(已弃用)

按条形码拆分 PDF [已弃用]

按条形码拆分 PDF 文档,返回多个 PDF 文档(已弃用)

提取 Excel 工作表 [已弃用]

从提供的 Excel 文件中提取指定的工作表(已弃用)

搜索和替换文本 [已弃用]

查找和替换 PDF 或 DOCX 文档中包含的文本(已弃用)

旋转图像 [已弃用]

按指定度旋转图像(已弃用)

映像清理 - 文档 [已弃用]

执行以基于文本的图像为中心的图像清理活动(已弃用)

更新 Excel 中的行 [已弃用]

更新提供的 Excel 文件中的指定行(已弃用)

更新 Word - 删除页眉和页脚 [已弃用]

从提供的 Microsoft Word 文档中删除页眉和/或页脚(已弃用)

更新 Word - 添加页眉和页脚 [已弃用]

将 HTML 页眉和/或页脚添加到提供的 Microsoft Word 文档(已弃用)

更新 Word - 目录 [已弃用]

更新提供的 Microsoft Word 文档中的“目录”(已弃用)

更新 Word - 超链接 [已弃用]

查找和更新Microsoft Word 文档中包含的超链接(已弃用)

比较 Word 文档 [已弃用]

比较Microsoft Word 和 PDF 文档之间的差异(已弃用)

添加到存档 [已弃用]

将所提供的文件添加到存档文件(已弃用)

添加页码 [已弃用]

向提供的 PDF 文档添加页码(已弃用)

禁用修订 [已弃用]

禁用提供的 Microsoft Word 文档的修订(已弃用)

签名 PDF [已弃用]

将数字签名应用于提供的 PDF 文档(已弃用)

管理修订 [已弃用]

处理提供的 Microsoft Word 文档中的修订(已弃用)

翻转图像 [已弃用]

翻转提供的图像(已弃用)

获取 PDF 文本层 [已弃用]

获取提供的 PDF 文档的文本层(已弃用)

获取 PDF 文档信息 [已弃用]

获取 PDF 文档信息(已弃用)

获取 PDF 表单数据 [已弃用]

从 PDF 表单中提取 PDF 表单数据(已弃用)

获取修订 [已弃用]

获取提供的 Microsoft Word 文档的所有修订(修订和注释)(已弃用)

获取映像信息 [已弃用]

获取图像信息(已弃用)

获取电子邮件信息 [已弃用]

获取有关提供的电子邮件的详细信息(已弃用)

获取电子邮件附件 [已弃用]

从提供的电子邮件中提取附件并返回文件数组(已弃用)

获取订阅状态 - Flowr 和 Vertr [已弃用]

获取 Encodian 订阅的状态(已弃用)

获取订阅状态 - Trigr [已弃用]

获取 Encodian 订阅的状态(已弃用)

裁剪图像 [已弃用]

使用边框值或矩形裁剪图像(已弃用)

解锁 PDF 文档 [已弃用]

解密和删除 PDF 文档的密码保护(已弃用)

设置 PDF 文档权限 [已弃用]

设置分配给 PDF 文档的特权(已弃用)

读取 QR 码 - 图像 [已弃用]

从提供的图像读取 QR 码(已弃用)

读取 QR 码 - 文档 [已弃用]

从提供的文档中读取 QR 码(已弃用)

读取条形码 - 图像 [已弃用]

从提供的图像中读取条形码(已弃用)

读取条形码 - 文档 [已弃用]

从提供的文档读取条形码(已弃用)

调整 PDF 大小 [已弃用]

调整 PDF 文档的大小(已弃用)

调整图像大小 [已弃用]

重设图像大小并压缩提供的图像(已弃用)

转换 CAD [已弃用]

将 CAD 文件转换为其他文档格式(已弃用)

转换 Excel [已弃用]

将Microsoft Excel 文档转换为另一种文档格式(已弃用)

转换 PowerPoint [已弃用]

将 Microsoft PowerPoint 文档转换为另一种文档格式(已弃用)

转换 Visio [已弃用]

将 Microsoft Visio 文档转换为另一种文档格式(已弃用)

转换 Word [已弃用]

将 Microsoft Word 文档转换为其他文档格式(已弃用)

转换为 PDF [已弃用]

将文档转换为 PDF 或 PDF/A 格式(已弃用)

转换图像格式 [已弃用]

转换提供的图像的格式(已弃用)

转换电子邮件 [已弃用]

将电子邮件转换为 PDF (已弃用)

OCR PDF 文档 [已弃用]

对现有 PDF 文档执行 OCR (已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
FileContent byte

源文件的文件内容

语言
ocrLanguage string

选择用于 OCR 处理的语言

OCR 类型
ocrType string

选择 OCR 处理类型,“快速”选项可减少处理时间,并可能轻微丢失 OCR 准确性 - https://support.encodian.com/hc/en-gb/articles/360012686653-OCR-a-PDF-Document

PDF/A 合规
pdfaCompliance boolean

设置 PDF/A 符合性选项

PDF/A 合规性级别
pdfaComplianceLevel string

设置 PDF/A 符合性级别,默认值为PDF_A_2A。

清理作
cleanUpType string

执行文档清理作,默认选项将自动旋转、自动桌面和自动取消指定文档。

旋转
AutoRotate boolean

自动检测方向并旋转方向,以便其上的文本面向直立

轮换置信度
AutoRotateConfidenceLevel integer

设置用于控制是否应用旋转的最小置信度百分比(0 到 100),默认值为 60。

Deskew
Deskew boolean

检测倾斜角度并旋转以移除该倾斜。

Despeckle
Despeckle boolean

自动检测斑点并删除它们。

调整亮度和对比度
AdjustBrightnessContrast boolean

此作分析文档,并根据分析自动调整亮度和对比度。

删除边框
RemoveBorder boolean

找到边框像素并删除文档中的像素,默认情况下会禁用此像素。

平滑背景
SmoothBackground boolean

这仅适用于颜色和灰度文档。 此作可平滑背景色以消除或取消强调噪音。

平滑对象
SmoothObjects boolean

这仅适用于位文档,它查看像素组,并在这些对象的边缘找到隔离的颠簸和坑,并填充它们。

删除点底纹
RemoveDotShading boolean

此作将从位文档中删除着色区域。

图像洗涤剂
ImageDetergent boolean

图像洗涤剂的工作原理是将类似颜色值的像素更改为中心颜色值,这会导致图像在出现这些颜色的区域时平滑显示。

平均筛选器
ApplyAverageFilter boolean

对文档执行 3x3 平均筛选器平滑作,将输出置于窗口的中心。

删除孔孔打孔
RemoveHolePunch boolean

检测和删除位文档中的孔打孔标记。

Binarize
Binarize boolean

通过在实际执行二进制化之前分析输入数据来计算所有必要的参数。 该算法针对典型的文档图像进行了优化,该图像由较亮的背景上的深色文本组成。 它对于阴影、噪音和背景图像是可靠的。

删除空白页
RemoveBlankPages boolean

设置是否应从 PDF 文档中删除空白页。

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

Redact PDF [已弃用]

将指定的修订应用于提供的 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

源文件的文件内容

文本
SearchText string

要搜索并向其应用指定修订的文本。

Expression
SearchExpression string

指定正则表达式以查找匹配的文本并应用指定的修订。

修订颜色
RedactionColour string

要应用于修订的修订颜色,默认值为 #000000 (黑色)

跳过第一页
skipFirstPage boolean

设置是否忽略第一页。

应用于
applyTo string

设置文档中要编辑的页面

页码
pageNumbers array of integer

指定要向其应用修订的页码,仅当“应用于”属性设置为“Specific”时,此属性才适用。

忽略页码
ignorePageNumbers array of integer

指定页码不应用修订,仅当“应用于”属性设置为“Specific”时,此属性才适用。

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

从 Excel 中删除行 [已弃用]

从提供的 Excel 文件中删除行(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源 Excel 文件的文件内容

第一行
firstRow integer

设置要删除的第一行的数目

最后一行
lastRow integer

设置要删除的最后一行的数目

工作表名称
worksheetName string

设置要从中删除行的特定工作表的名称

行数组
rowArray string

设置要删除的行数组,符合以下结构:[23-56],[100-120],[156-8988]

返回

从 Excel 获取行 [已弃用]

从提供的 Excel 文件获取行(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源文件的文件内容

工作表名称
worksheetName string

设置要导出的特定工作表的名称

具有标题行
hasHeaderRow boolean

设置指定的第一行是否为标题行

第一行
firstRow integer

设置要导出的第一行的数目

最后一行
lastRow integer

将最后一行的数目设置为要导出的行数

第一列
firstColumn integer

设置要导出的第一列的数目

最后一列
lastColumn integer

设置要导出的最后一列的数目

排除空行
excludeEmptyRows boolean

设置是否应从导出中排除空行

导出空单元格
exportEmptyCells boolean

设置是否应导出空单元格

将值导出为文本
exportValuesAsText boolean

设置值是否应导出为文本,即数字将导出为“value”:“3”

超链接格式
hyperlinkFormat string

设置应如何导出超链接

导出为对象
alwaysExportAsJsonObject boolean

强制将行数据导出为 JsonObject,即使文件中仅包含单个工作表

区域性名称
cultureName string

设置用于处理请求的线程区域性

返回

从 PDF 中删除水印 [已弃用]

从提供的 PDF 文档中删除指定的水印(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent True byte

源文件的文件内容

水印 ID
watermarkIds string

要移除的水印的标识符。 应提供多个标识符,以逗号分隔

水印类型
removeWatermarkType string

设置要从提供的 PDF 文档中删除的水印类型

返回

从 PDF 中提取图像 [已弃用]

使用指定区域从 PDF 中提取图像(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
FileContent byte

源文件的文件内容

Name
Name string

分配给提取映像的名称

左下 X 坐标
LowerLeftXCoordinate True double

从页面左边缘到矩形图像区域的左下角的点数

左下 Y 坐标
LowerLeftYCoordinate True double

从页面底部边缘到矩形图像区域的左下角的点数

右上方 X 坐标
UpperRightXCoordinate True double

从页面左边缘到矩形图像区域的右上角的点数

右上 Y 坐标
UpperRightYCoordinate True double

从页面底部边缘到矩形图像区域的右上角的点数

页码
PageNumber True integer

要从中提取图像的页面数

ImageType
ImageType True string
提取整个页面
ExtractEntirePage True boolean

将指定的页面提取为图像,忽略和特定的涂鸦

决议
Resolution True integer

提取图像的分辨率

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

从 PDF 中提取附件 [已弃用]

从提供的 PDF 中提取附件(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源文件的文件内容

返回

从 Word 中删除水印 [已弃用]

从提供的 Word 文件中删除水印(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源Microsoft Word 文件的文件名,文件扩展名是必需的:“file.docx”,而不是“file”

文件内容
fileContent True byte

源Microsoft Word 文件的文件内容

区域性名称
cultureName string

更改用于处理请求的线程区域性

返回

从 Word 获取文本 [已弃用]

获取提供的 Microsoft Word 文件中包含的文本(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

Microsoft Word 文件的文件内容

起始页
startPage integer

设置页码以开始从中提取文本层

结束页
endPage integer

设置页码以结束从中提取文本层。 默认值设置为提供的 Microsoft Word 文档的最后一页

删除批注
removeComments boolean

设置在从 Microsoft Word 文件提取文本之前是否应删除注释

接受更改
acceptChanges boolean

设置在从 Microsoft Word 文件提取文本之前是否应接受修订

删除页眉和页脚
removeHeadersAndFooters boolean

设置是否应从 Microsoft Word 文件中删除页眉和页脚

区域性名称
cultureName string

更改用于处理请求的线程区域性

返回

从区域提取文本 [已弃用]

使用指定的区域从 70 多个文件类型使用 OCR 提取文本(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
FileContent byte

源文件的文件内容

Name
Name True string

分配给文本区域的名称

左下 X 坐标
LowerLeftXCoordinate True double

从页面左边缘到矩形文本区域的左下角的点数

左下 Y 坐标
LowerLeftYCoordinate True double

从页面底部边缘到矩形文本区域的左下角的点数

右上方 X 坐标
UpperRightXCoordinate True double

从页面左边缘到矩形文本区域的右上角的点数

右上 Y 坐标
UpperRightYCoordinate True double

从页面底部边缘到矩形文本区域的右上角的点数

页码
Page Number True integer
操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

从图像中提取文本 [已弃用]

从提供的图像中提取文本(已弃用)

参数

名称 密钥 必需 类型 说明
映像类型
imageType True string

选择图像文件格式。

文件内容
fileContent True byte

源映像文件的文件内容

语言
ocrLanguage string

选择用于 OCR 处理的语言

清理作
cleanUpType string

执行文档清理作,默认选项将自动旋转、自动桌面和自动取消指定文档。

旋转
AutoRotate boolean

自动检测方向并旋转方向,以便其上的文本面向直立

轮换置信度
AutoRotateConfidenceLevel integer

设置用于控制是否应用旋转的最小置信度百分比(0 到 100),默认值为 70。

Deskew
Deskew boolean

检测倾斜角度并旋转以移除该倾斜。

Despeckle
Despeckle boolean

自动检测斑点并删除它们。

调整亮度和对比度
AdjustBrightnessContrast boolean

此作分析文档,并根据分析自动调整亮度和对比度。

删除边框
RemoveBorder boolean

找到边框像素并删除文档中的像素,默认情况下会禁用此像素。

平滑背景
SmoothBackground boolean

这仅适用于颜色和灰度文档。 此作可平滑背景色以消除或取消强调噪音。

平滑对象
SmoothObjects boolean

这仅适用于位文档,它查看像素组,并在这些对象的边缘找到隔离的颠簸和坑,并填充它们。

删除点底纹
RemoveDotShading boolean

此作将从位文档中删除着色区域。

图像洗涤剂
ImageDetergent boolean

图像洗涤剂的工作原理是将类似颜色值的像素更改为中心颜色值,这会导致图像在出现这些颜色的区域时平滑显示。

平均筛选器
ApplyAverageFilter boolean

对文档执行 3x3 平均筛选器平滑作,将输出置于窗口的中心。

删除孔孔打孔
RemoveHolePunch boolean

检测和删除位文档中的孔打孔标记。

Binarize
Binarize boolean

通过在实际执行二进制化之前分析输入数据来计算所有必要的参数。 该算法针对典型的文档图像进行了优化,该图像由较亮的背景上的深色文本组成。 它对于阴影、噪音和背景图像是可靠的。

返回

从存档中提取 [已弃用]

从提供的存档中提取文件(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

存档的文件内容

密码
password string

设置用于打开存档的密码

包含文件夹
includeFolders True boolean

设置是否提取存档中存在的文件夹中包含的文件

返回

从映像中删除 EXIF 标记 [已弃用]

从指定的映像中删除 EXIF 标记(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源映像文件的文件内容

映像类型
imageType True string

选择图像文件格式。

返回

修复 PDF [已弃用]

修复 PDF 文档 (已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源文件的文件内容

返回

分析 CSV [已弃用]

分析 CSV 并返回 JSON 格式提取的数据(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
FileContent True byte

源 CSV 文件的文件内容

分隔符
delimiter string

设置 CSV 分隔符,默认值为逗号:“,”

列标题
csvColumnHeaders string

手动设置 CSV 数据的列标题(列分隔:列 1、列 2 等)。

跳过第一行
skipFirstLine boolean

跳过 CSV 文件的第一行,如果 CSV 文档包含列标题,则设置为“是”

返回

创建 QR 代码 [已弃用]

使用指定的图像格式创建 QR 码(已弃用)

参数

名称 密钥 必需 类型 说明
条形码数据
barcodeData True string

设置用于生成 QR 条形码的字符串值。

图像格式
barcodeImageFormat True string

设置条形码的图像格式。

高度
height integer

设置 QR 码高度(像素)。

宽度
width integer

设置 QR 码宽度(像素)。

自动调整大小模式
sizeMode string

设置 QR 自动大小模式,使用“最接近”确保 QR 码可读性

前景色
foreColor string

设置 QR 码前景色 (HTML 颜色 #0000000)

后退颜色
backColor string

设置 QR 码背景色(HTML 颜色 #FFFFFF)

可见边框
visibleBorder boolean

设置 QR 码边框是否可见

边框颜色
borderColor string

设置 QR 码边框颜色(HTML 颜色 #0000000)

边框样式
borderStyle string

设置 QR 码边框样式

边框宽度
borderWidth integer

设置 QR 码边框宽度(以像素为单位)

决议
resolution integer

设置 QR 码边框图像分辨率(dpi)

编码模式
encodeMode string

设置 QR 码编码模式

编码类型
encodeType string

设置 QR 码编码类型

编码类型
textEncodingType string

设置 QR 码文本编码类型

徽标文件名
logoFileName string

源徽标文件的文件名,文件扩展名是必需的:“file.png”,而不是“file”

徽标文件内容
logoFileContent byte

源徽标文件的文件内容

徽标位置
logoPosition string

设置徽标的位置

文本上方的标题
captionAboveText string

设置文本上方的标题

字体上方的标题
captionAboveFont string

设置标题文本的字体

字号上方的标题
captionAboveFontSize integer

设置标题文本的字体大小

字体颜色上方的标题
captionAboveFontColour string

设置标题文本的字体颜色

对齐方式上方的标题
captionAboveAlignment string

设置标题文本的对齐方式

标题上方无换行
captionAboveNoWrap boolean

设置标题文本的环绕

文本下方的标题
captionBelowText string

设置以下文本的标题

字体下方的标题
captionBelowFont string

设置标题文本的字体

字号下方的标题
captionBelowFontSize integer

设置标题文本的字体大小

字体颜色下方的标题
captionBelowFontColour string

设置标题文本的字体颜色

对齐方式下方的标题
captionBelowAlignment string

设置标题文本的对齐方式

标题下方无换行
captionBelowNoWrap boolean

设置标题文本的环绕

返回

创建条形码 [已弃用]

使用指定的图像格式创建条形码(已弃用)

参数

名称 密钥 必需 类型 说明
条形码类型
barcodeTypeParameter string

设置条形码类型

操作
operation dynamic

请求对象,请参阅架构定义:DtoResponseCreateBarcode

返回

压缩 PDF [已弃用]

压缩和优化 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源文件的文件内容

压缩图像
compressImages boolean

将压缩包含的图像,使其与“图像质量”属性的值对齐

图像质量
imageQuality integer

设置压缩图像的质量:1 > 100

最大分辨率
maxResolution integer

指定图像的最大分辨率(dpi),如果图像的分辨率更高,则会动态缩放。

调整图像大小
resizeImages boolean

如果启用了“压缩图像”和“调整图像大小”,则图像分辨率将大于指定的“最大分辨率”属性的大小。

删除专用信息
removePrivateInfo boolean

从 PDF 文档中删除私人信息,即页段信息。

删除未使用的对象
removeUnusedObjects boolean

从 PDF 文档中删除所有未使用的对象(即没有引用的对象)。

删除未使用的流
removeUnusedStreams boolean

从 PDF 文档中删除所有未使用的资源。

链接重复流
linkDuplicateStreams boolean

链接重复的流并将其存储为单个对象。 在某些情况下,这可以减少文档大小(例如,同一文档合并多次)。

允许重复使用页面内容
allowReusePageContent boolean

当 PDF 文档针对相同页面进行优化时,将重复使用页面内容。

未嵌入的字体
unembedFonts boolean

删除所有嵌入字体。 文档大小会减少,但如果用户计算机上未安装正确的字体,文档可能会变得不可读。

平展批注
flattenAnnotations boolean

平展 PDF 文档中包含的所有批注。

删除批注
deleteAnnotations boolean

删除 PDF 文档中包含的所有批注。

平展字段
flattenFields boolean

平展 PDF 文档中包含的所有字段(仅限 AcroForms)。

返回

压缩 PowerPoint [已弃用]

压缩提供的 PowerPoint 文件(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源文件的文件名,文件扩展名是必需的:“file.pptx”,而不是“file”

文件内容
fileContent True byte

源文件的文件内容

图像压缩率
compressionRate string

设置图像的压缩率。 较高的压缩率会生成较小的文件大小。

删除嵌入字体
compressEmbeddedFonts boolean

通过从嵌入字体中删除未使用的字符来压缩文件

删除未使用的版式幻灯片
removeUnusedLayoutSlides boolean

通过删除未使用的版式幻灯片压缩文件

删除未使用的母版幻灯片
removeUnusedMasterSlides boolean

通过删除未使用的母版幻灯片压缩文件

将图像大小调整为框架大小
resizeImagesToFrameSize boolean

调整图像大小以适应显示图像的框架

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

压缩映像 [已弃用]

压缩提供的映像(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源映像文件的文件内容

映像类型
imageType True string

选择图像文件格式。

返回

发送到 Encodian Filer [已弃用]

将数据发送到 Encodian Filer 终结点(已弃用)

参数

名称 密钥 必需 类型 说明
API 终结点
apiEndpoint True string

设置 Encodian Filer 终结点 URL。

API 密钥
apiKey True string

设置用于身份验证的 Encodian Filer API 密钥。

Data
data True string

提供要发送到 Encodian Filer(正文)的数据有效负载。

HTTP 方法
httpMethod True string

设置 HTTP 方法类型。

返回

合并 Excel 文件 [已弃用]

将Microsoft Excel 文件的数组合并到单个文件(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
outputFilename string

输出 excel 文件的文件名

输出格式
mergeExcelOutputFormat string

输出 excel 文件的格式

Filename
fileName True string

源文件的文件名,文件扩展名是必需的:“file.xlsx”,而不是“file”

文件内容
fileContent True byte

源文件的文件内容

排序位置
sortPosition integer

设置文档数组中的排序位置

要合并的工作表
worksheetsToMerge array of integer

指定应包含在输出中的源文件中的工作表

返回

合并 Excel 行 [已弃用]

将 Excel 文件中包含的行合并到单个工作表中(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
outputFilename string

输出 excel 文件的文件名

输出格式
outputFormat True string

输出 excel 文件的格式

Filename
fileName True string

源文件的文件名,文件扩展名是必需的:“file.xlsx”,而不是“file”

文件内容
fileContent True byte

源文件的文件内容

排序位置
sortPosition integer

设置数组中文档的排序位置,首先设置最低数字

要合并的工作表
worksheetsToMerge array of integer

指定应包含在输出中的源文件中的工作表

包括第一行
includeFirstRow boolean

设置是否包含工作表的第一行

保留第一行
preserveFirstRow boolean

确保始终保留第一个工作簿和工作表的第一行

返回

合并 Word 文档 [已弃用]

将 Microsoft Word 文档的数组合并到单个Microsoft Word 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
outputFilename True string

输出 DOCX 文档的文件名

Filename
fileName True string

源文件的文件名,文件扩展名是必需的:“file.docx”,而不是“file”

文件内容
fileContent True byte

源文件的文件内容

排序位置
sortPosition integer

设置文档数组中的排序位置

格式模式
wordInputFormatMode string

设置在将文档合并到数组中的第一个文档时如何处理格式设置。

时区
timezone string

设置日期和时间处理的特定时区

返回

合并演示文稿 [已弃用]

将演示文稿数组合并到单个演示文稿(已弃用)

参数

名称 密钥 必需 类型 说明
文件格式
mergePresentationOutputFormat True string

输出演示文稿文件的格式

Filename
outputFilename string

输出演示文稿文件的文件名,默认设置为“presentation”

Filename
fileName True string

源文件的文件名,文件扩展名是必需的:“file.pptx”,而不是“file”

文件内容
fileContent True byte

源文件的文件内容

排序位置
sortPosition integer

设置文档数组中的排序位置

幻灯片
slidesToMerge array of integer

指定要包含在输出中的幻灯片

母版样式
mergePresentationMasterStyle boolean

将第一个提供的演示文稿的样式应用于所有其他演示文稿,默认情况下设置为“false”

返回

向 Word 添加文本水印 [已弃用]

将文本水印添加到指定的Microsoft Word 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源Microsoft Word 文件的文件名,文件扩展名是必需的:“file.docx”,而不是“file”

文件内容
fileContent True byte

源Microsoft Word 文件的文件内容

文本
text True string

要嵌入为Microsoft Word 文件中水印的文本

方向
orientation string

设置文本水印的方向

区域性名称
cultureName string

更改用于处理请求的线程区域性

字体
font string

设置应用于文本水印的字体类型,默认字体设置为 Calibri

文本颜色
textColour string

设置应用于文本水印的 HTML 颜色,默认颜色设置为 #808080 (灰色)

文本大小
textSize integer

设置应用于文本水印的字号,默认大小设置为 0(自动)

半透明
isSemiTransparent boolean

设置文本水印是否应为半透明

返回

向图像添加文本水印 [已弃用]

向提供的图像添加文本水印(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.jpg”,而不是“file”

文件内容
FileContent byte

源映像文件的文件内容

文本
Text True string

要嵌入为图像中的水印的文本

水印位置
WatermarkPosition string

要嵌入为图像中的水印的文本的位置

字体
Font string

应用于文本水印的字体,默认字体设置为 Arial。

文本颜色
TextColour string

应用于文本水印的 HTML 颜色,默认颜色设置为 #E81123。

文本大小
TextSize integer

应用于文本水印的字体大小,默认大小设置为 10。

返回

启用修订 [已弃用]

对提供的 Microsoft Word 文档启用修订(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源Microsoft Word 文件的文件名,文件扩展名是必需的:“file.docx”,而不是“file”

文件内容
fileContent True byte

源Microsoft Word 文档的文件内容

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

图像清理 - 照片 [已弃用]

执行标准照片图像的图像清理活动(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.png”,而不是“file”

文件内容
FileContent byte

源映像文件的文件内容

清理作
cleanUpType string

执行文件清理作,默认选项将自动旋转、应用颜色平衡、自动桌面和自动取消指定提供的文件。

Deskew
Deskew boolean

检测倾斜角度并旋转以删除该倾斜,这是默认启用的。

Despeckle
Despeckle boolean

自动检测斑点并删除它们,默认启用此功能。

颜色平衡
ColorBalance boolean

还原并平衡图像中的颜色质量,默认启用此功能。

删除边框
RemoveBorder boolean

找到边框像素并删除文档中的像素,默认情况下禁用此像素。

反差
Contrast boolean

调整当前图像中的对比度。

删除 Redeye
RemoveRedeye boolean

自动减少在彩色闪光照片图像中人眼中看到的闪光的红色反射。

模糊
Blur boolean

通过对每个像素的平均值来模糊当前图像,其中每个像素的相邻像素都使它“失去焦点”的外观。

弥漫 性
Diffuse boolean

通过将每个像素替换为随机选择的相邻像素来漫射当前图像。

Binarize
Binarize boolean

通过在实际执行二进制化之前分析输入数据来计算所有必要的参数。 该算法针对典型的文档图像进行了优化,该图像由较亮的背景上的深色文本组成。 它对于阴影、噪音和背景图像很可靠,默认情况下禁用此功能。

旋转
AutoRotate boolean

自动检测方向和旋转,使文本面向直立,默认启用此功能。

轮换置信度
AutoRotateConfidenceLevel integer

设置用于控制是否应用旋转的最小置信度百分比(0 到 100),默认值为 40。

返回

填充 Excel [已弃用]

使用提供的 JSON 数据填充Microsoft Excel 工作簿(XLSX)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

要填充的Microsoft Excel 工作簿(XLSX)

JSON 数据
jsonData True string

用于使用

JSON 分析模式
jsonParseMode string

设置简单值的 JSON 分析模式(null、布尔值、数字、整数和字符串)

计算工作簿
calculateWorkbook boolean

自动计算总体公式

使用 Excel 数据类型
useExcelDataTypes boolean

使用相应的 Excel 数据类型(而不是字符串数据类型)将启用的数据添加到工作簿时

允许缺失值
allowMissingMembers boolean

设置引擎以允许“JSON 数据”中的缺失值

内联错误
inlineErrorMessages boolean

在生成的工作簿中生成错误,而不是拒绝请求并出现 HTTP 4** 错误

删除空段落
removeEmptyParagraphs boolean

设置引擎以在执行时自动删除任何空段落

日期时间格式
dateTimeFormat string

设置一个或多个规范格式以分析 DateTime 值

区域性名称
cultureName string

更改用于处理请求的线程区域性

返回

填充 PowerPoint [已弃用]

使用提供的 JSON 数据填充Microsoft PowerPoint 文件(PPTX)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

要填充的 Microsoft PowerPoint 文件 (PPTX)

JSON 数据
jsonData True string

使用

JSON 分析模式
jsonParseMode string

设置简单值的 JSON 分析模式(null、布尔值、数字、整数和字符串)

允许缺失值
allowMissingMembers boolean

设置引擎以允许“文档数据”中的缺失值

内联错误
inlineErrorMessages boolean

在生成的文档中生成错误,而不是拒绝请求并出现 HTTP 4** 错误

删除空段落
removeEmptyParagraphs boolean

设置引擎以在执行时自动删除任何空段落

日期时间格式
dateTimeFormat string

设置一个或多个规范格式以分析 DateTime 值

区域性名称
cultureName string

更改用于处理请求的线程区域性

返回

填充 Word 文档 [已弃用]

使用提供的 JSON 数据填充Microsoft Word 文档(DOCX)(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

要填充的Microsoft Word 文档(DOCX)

文档数据
documentData True string

使用

JSON 分析模式
jsonParseMode string

设置简单值的 JSON 分析模式(null、布尔值、数字、整数和字符串)

允许缺失值
allowMissingMembers boolean

设置引擎以允许“文档数据”中的缺失值

内联错误
inlineErrorMessages boolean

在生成的文档中生成错误,而不是拒绝请求并出现 HTTP 4** 错误

删除空段落
removeEmptyParagraphs boolean

设置引擎以在执行时自动删除任何空段落

日期时间格式
dateTimeFormat string

设置一个或多个规范格式以分析 DateTime 值

区域性名称
cultureName string

更改用于处理请求的线程区域性

时区
timezone string

设置日期和时间处理的特定时区

返回

填写 PDF 表单 [已弃用]

使用提供的 JSON 数据填充 PDF 表单(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
FileContent byte

源文件的文件内容

表单数据
formData True string

要填充 PDF 窗体的 JSON 数据。

返回

安全 PDF 文档 [已弃用]

加密和保护 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

源文件的文件内容

查看密码
userPassword string

保护对文档的视图访问权限

编辑密码
adminPassword string

保护对文档的编辑访问权限

特权
pdfPrivileges string

设置分配给 PDF 文档的权限

加密算法
cryptoAlgorithm string

设置加密算法

特权 - 程序集
pdfPrivilegesAllowAssembly boolean

设置是否允许文档程序集

特权 - 复制
pdfPrivilegesAllowCopy boolean

设置是否允许复制

特权 - 填写表单
pdfPrivilegesAllowFillIn boolean

设置是否允许“填写表单”

特权 - 打印
pdfPrivilegesAllowPrint boolean

设置是否允许打印

特权 - 屏幕阅读器
pdfPrivilegesAllowScreenReaders boolean

设置是否允许屏幕读取

特权 - 修改内容
pdfPrivilegesAllowModifyContents boolean

设置是否允许文档内容修改

特权 - 修改批注
pdfPrivilegesAllowModifyAnnotations boolean

设置是否允许批注修改

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

安全 Word 文档 [已弃用]

保护和保护Microsoft Word 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源Microsoft Word 文件的文件名,文件扩展名是必需的:“file.docx”,而不是“file”

文件内容
fileContent True byte

源Microsoft Word 文件的文件内容

保护类型
wordProtectionType string

设置 Microsoft Word 文档的保护类型

保护密码
password string

设置用于保护 Microsoft Word 文档的密码

打开时安全
secureOnOpen boolean

设置是否需要密码才能打开 Microsoft Word 文档

在打开密码时安全
secureOnOpenPassword string

设置用于打开 Microsoft Word 文档的密码

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

实用工具 - AES 加密 [已弃用]

使用 AES 加密(已弃用)加密纯文本值(字符串)

参数

名称 密钥 必需 类型 说明
Data
data True string

要加密的输入字符串

输出类型
outputDataEncodingMethod True string

设置加密字符串的数据格式

Key
key True string

设置算法中使用的密钥(机密)

模式
mode True string

设置 AES 加密算法

初始化向量
initializationVector string

可选 - 仅当模式设置为“CBC”或“CFB”时,才应提供“初始化向量”

填充
padding string

设置对称算法中使用的填充模式,默认值为 PKCS7

返回

实用工具 - AES 解密 [已弃用]

使用 AES 解密对 AES 加密的字符串进行解密 (已弃用)

参数

名称 密钥 必需 类型 说明
Data
data True string

要解密的密码(字符串)

输入类型
inputDataEncodingMethod True string

设置加密字符串的数据格式

Key
key True string

设置算法中使用的密钥(机密)

模式
mode True string

设置 AES 加密算法

初始化向量
initializationVector string

可选 - 仅当模式设置为“CBC”或“CFB”时,才应提供“初始化向量”

填充
padding string

设置对称算法中使用的填充模式,默认值为 PKCS7

返回

实用工具 - Unescape HTML [已弃用]

取消设置提供的 HTML 值(已弃用)

参数

名称 密钥 必需 类型 说明
HTML
html True string

要处理的 HTML 值

返回

实用工具 - 从文本中提取 URL [已弃用]

从提供的文本值中提取 URL (已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要从中提取 URL 的文本

正则表达式
regex True string

用于提取的默认正则表达式

返回

实用工具 - 从文本中提取电子邮件地址 [已弃用]

从提供的文本值中提取电子邮件地址(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要从中提取电子邮件地址的文本

正则表达式
regex True string

用于提取的默认正则表达式

返回

实用工具 - 使用正则表达式搜索文本 [已弃用]

使用提供的正则表达式搜索提供的文本以查找匹配项(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

使用提供的正则表达式字符串进行搜索的文本

正则表达式查询
query True string

用于在提供的字符串中查找匹配项的正则表达式查询

ECMAScript
ecmaScript boolean

为表达式启用符合 ECMAScript 的行为。 此值只能与 IgnoreCase 和多行选项结合使用。 默认已禁用。

显式捕获
explicitCapture boolean

指定默认禁用窗体的显式命名或编号组的唯一有效捕获。

忽略大小写
ignoreCase boolean

指定默认情况下禁用的不区分大小写的匹配。

忽略空格
ignoreWhitespace boolean

从模式中消除未转义的空格,并启用标记为 #的注释,默认情况下禁用。

多行
multiline boolean

更改 ^ 和 $ 的含义,以便它们分别在任何行的开头和结尾匹配,而不仅仅是整个字符串的开头和结尾,默认情况下禁用。

从右到左
rightToLeft boolean

指定搜索将从右到左,而不是从左到右,默认情况下禁用。

单行
singleline boolean

指定单行模式。 更改点(.)的含义,使其与每个字符(而不是除 \n以外的每个字符)匹配,默认情况下禁用。

返回组
returnGroups boolean

指定搜索将返回匹配组而不是匹配值

返回

实用工具 - 分析 HTML 表 [已弃用]

分析提供给 JSON 的 HTML 中包含的表(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent byte

可选 - 源 HTML 文件的文件内容。

HTML 数据
html string

可选 - 要分析的 HTML

表索引
tableIndex integer

将 HTML 表的索引设置为分析,当 HTML 中存在多个表时(默认值为 1)

表 ID
tableId string

将 HTML 表的 ID 设置为分析,当 HTML 中存在多个表时

数量筛选器
quantityFilter integer

获取具有指定列数的行

内容筛选器
contentFilter string

设置仅分析与指定类型匹配的表单元格

返回

实用工具 - 创建 GUID [已弃用]

生成新的 GUID (已弃用)

参数

名称 密钥 必需 类型 说明
案例
case True string

设置 GUID(下部或上部)

返回

实用工具 - 创建 HMAC [已弃用]

使用密钥创建基于哈希的消息身份验证代码(HMAC)(已弃用)

参数

名称 密钥 必需 类型 说明
Data
data string

提供要计算的输入数据

数据类型
cryptoInputDataType string

设置提供的输入数据的数据格式。

Key
key True string

提供用于计算基于哈希的消息身份验证代码(HMAC)的密钥(机密)

键类型
cryptoKeyDataType string

设置提供的密钥的数据格式。

摘要算法
digestAlgorithm True string

选择消息摘要算法

输出类型
cryptoOutputDataType string

设置生成的 HMAC 的数据格式

案例
case string

设置应用于计算值的情况。

编码类型
encoding string

选择编码类型。

返回

实用工具 - 创建哈希代码 [已弃用]

为提供的字符串创建哈希代码(已弃用)

参数

名称 密钥 必需 类型 说明
Data
data True string

提供要计算的输入数据

数据类型
cryptoInputDataType string

设置提供的输入数据的数据格式。

摘要算法
digestAlgorithm True string

选择消息摘要算法

输出类型
cryptoOutputDataType string

设置生成的哈希代码的数据格式。

案例
case string

设置应用于计算值的情况。

编码类型
encoding string

选择编码类型。

返回

实用工具 - 删除值之间的文本 [已弃用]

从提供的两个值之间删除字符串中的文本(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要从中删除值的文本

起始值
startValue True string

要从中删除的文本值

结束值
endValue True string

要结束从中删除的文本值

忽略大小写
ignoreCase boolean

设置在执行删除作时是否应忽略文本大小写

剪裁结果
trimResult boolean

设置是否应从已删除的字符串中剪裁空格

替换为
replaceWith string

设置一个值以将已删除的值替换为

包括值
includeValues string

设置删除中是否应包括起始值和结束值之一或两者

返回

实用工具 - 删除音调符号 [已弃用]

从提供的文本中删除音调符号(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要处理的文本值

区域性名称
cultureName string

更改用于处理请求的线程区域性。

剪裁结果
trimResult boolean

设置是否应从处理的文本值中剪裁空格

返回

实用工具 - 剪裁文本 [已弃用]

剪裁提供给集配置的文本值(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要处理的文本值

剪裁位置
textTrimPosition True string

设置是剪裁从起始位置、结束位置还是同时提供的文本

剪裁字符
trimCharacters string

可选 - 字符列表(可以包括空格)从提供的文本中剪裁,例如:&*yt^ :{

返回

实用工具 - 将值替换为文本 [已弃用]

替换提供的文本中的值(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要处理的文本值

搜索文本
searchText string

要查找并替换为“替换文本”值的文本,空白值被视为空白值

替换文本
replacementText string

要替换匹配值的文本,空白值将删除匹配的文本值

剪裁结果
trimResult boolean

设置是否应从处理的文本值中剪裁空格

返回

实用工具 - 将值替换为正则表达式 [已弃用]

替换使用正则表达式查询提供的文本中的值(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要处理的文本值

正则表达式
regex True string

用于查找文本值中的匹配项的正则表达式查询

替换文本
replacementText string

可选 - 替换匹配值的文本,空白值将删除匹配的文本值

剪裁结果
trimResult boolean

设置是否应从处理的文本值中剪裁空格

返回

实用工具 - 拆分文本 [已弃用]

使用集分隔符拆分提供的文本(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要处理的文本值

拆分值
splitValue string

设置用于拆分所提供文本的值

拆分打开
splitOn string

设置是否应在所有实例、第一个实例或“拆分值”的最后一个实例上拆分文本

剪裁值
trimResult boolean

设置是否应从从提供的文本拆分的值中剪裁空格

删除空值
removeEmptyValues boolean

设置是否应从返回的值数组中删除空值或 null 值

返回

实用工具 - 提取值之间的文本 [已弃用]

从提供的两个值之间的字符串中提取文本(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要从中提取值的文本

起始值
startValue string

要从中开始提取的文本值

结束值
endValue string

要结束从中提取的文本值

忽略大小写
ignoreCase boolean

设置在执行提取时是否应忽略文本大小写

包括值
includeValues string

设置结果中是否应包括“起始值”和“结束值”的任何或两者

剪裁结果
trimResult boolean

设置是否应从提取的字符串中剪裁空格

返回

实用工具 - 提取值之间的文本实例 [已弃用]

从提供的两个值之间的字符串中提取所有文本实例(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要从中提取值的文本

起始值
startValue string

从中开始提取的文本值

结束值
endValue string

要结束从中提取的文本值

忽略大小写
ignoreCase boolean

设置在执行提取时是否应忽略文本大小写

包括值
includeValues string

设置是否应在提取的文本中包含“起始值”和“结束值”中的任何或两者

剪裁结果
trimResult boolean

设置是否应从提取的文本中剪裁空格

删除空值
removeEmptyValues boolean

设置是否从结果数组中删除空字符串或 null 字符串(如果存在)

返回

实用工具 - 数组删除重复项 [已弃用]

从提供的数组中删除重复项(已弃用)

参数

名称 密钥 必需 类型 说明
Data
data True string

要修改的 JSON 数据

忽略大小写
ignoreCase True boolean

设置搜索重复项时是否应忽略文本大小写

路径
path string

使用 JSONPath 表达式选择“Data”中的特定节点

返回

实用工具 - 数组删除项 [已弃用]

从提供的数组中删除一个或多个项(已弃用)

参数

名称 密钥 必需 类型 说明
Data
data True string

要修改的 JSON 数据

项位置
itemPosition True string

设置是删除第一项、最后一项还是指定项

项索引
itemIndex integer

要删除的项的索引。 仅当“Item Position”属性设置为“Specific”时才适用

路径
path string

使用 JSONPath 表达式选择“Data”中的特定节点

返回

实用工具 - 数组到 JSON [已弃用]

将数组转换为命名 JSON 对象(已弃用)

参数

名称 密钥 必需 类型 说明
Data
data True string

要选择要转换为命名 JSON 对象的数组的数组或 JSON 对象

Name
name True string

要包含提供的或所选数组的 JSON 节点名称

路径
path string

使用 JSONPath 表达式选择“Data”中的特定数组

返回

实用工具 - 数组包含值 [已弃用]

检查是否包含在提供的数组中(已弃用)

参数

名称 密钥 必需 类型 说明
Data
data True string

要评估的 JSON 数据

价值
value True string

要检查的值包含在数组中

路径
path string

使用 JSONPath 表达式选择“Data”中的特定节点

忽略大小写
ignoreCase boolean

设置搜索数组时是否应忽略文本大小写

返回

实用工具 - 数组反向项 [已弃用]

反转提供的 JSON 数组中的项(已弃用)

参数

名称 密钥 必需 类型 说明
Data
data True string

要修改的 JSON 数据

路径
path string

使用 JSONPath 表达式选择“Data”中的特定节点

返回

实用工具 - 数组替换值 [已弃用]

将数组或指定项替换为提供的值(已弃用)

参数

名称 密钥 必需 类型 说明
Data
data True string

要评估的 JSON 数据

搜索值
searchValue string

要查找并替换为“替换值”的值,空白值被视为空格

替换值
replacementValue string

要替换匹配值的值,空白值将删除匹配的值

路径
path string

使用 JSONPath 表达式选择“Data”中的特定节点

返回

实用工具 - 数组添加项 [已弃用]

将一个或多个项添加到提供的数组(已弃用)

参数

名称 密钥 必需 类型 说明
Data
data True string

要修改的 JSON 数组或对象

物品
items True string

要添加到提供的“数据”的项

项位置
itemPosition True string

设置是返回第一项、最后一项还是指定项

项索引
itemIndex integer

要返回的项的索引。 仅当“Item Position”属性设置为“Specific”时才适用

路径
path string

使用 JSONPath 表达式选择“Data”中的特定节点

返回

实用工具 - 数组获取项 [已弃用]

从提供的 JSON 数组(s)获取指定的项(已弃用)

参数

名称 密钥 必需 类型 说明
Data
data True string

要计算的 JSON 数组或对象

项位置
itemPosition True string

设置是返回第一项、最后一项还是指定项

项索引
itemIndex integer

要返回的项的索引。 仅当“Item Position”属性设置为“Specific”时才适用

路径
path string

使用 JSONPath 表达式选择“Data”中的特定节点

返回

实用工具 - 数组计数项 [已弃用]

对提供的数组中包含的项进行计数(已弃用)

参数

名称 密钥 必需 类型 说明
Data
data True string

要修改的 JSON 数据

路径
path string

使用 JSONPath 表达式选择特定节点

返回

实用工具 - 文本包含值 [已弃用]

检查提供的文本值是否包含指定的文本值(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要验证的文本

价值
value True string

要检查的值包含在“Text”值内

忽略大小写
ignoreCase boolean

设置验证“Text”值时是否应忽略文本大小写

比较配置
comparisonConfiguration string

指定处理提供的文本值时要使用的规则

区域性名称
cultureName string

更改用于处理请求的线程区域性

返回

实用工具 - 格式日期 [已弃用]

将日期值格式化为所选格式配置(已弃用)

参数

名称 密钥 必需 类型 说明
日期
date True string

要设置格式的日期值

Format
format True string

设置日期格式 - https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

实用工具 - 比较文本 [已弃用]

比较提供的文本值(已弃用)

参数

名称 密钥 必需 类型 说明
主文本
primaryText True string

要比较的第一个文本值

辅助文本
secondaryText True string

要比较的第二个文本值

忽略大小写
ignoreCase boolean

设置比较提供的文本值时是否应忽略文本大小写

返回

实用工具 - 清理文本 [已弃用]

从提供的文本值中删除无效或指定的字符(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要处理的文本值

删除字符集
removeCharacterSet string

设置要从提供的文本值中删除的字符集合

删除控制字符
removeControlChars boolean

设置是否从文本值中删除控制字符

删除无效的文件名字符
removeInvalidFileNameChars boolean

设置是否从文本值中删除文件名无效的字符

剪裁结果
trimResult boolean

设置是否应从处理的文本值中剪裁空格

返回

实用工具 - 生成密码 [已弃用]

创建符合指定配置的密码(已弃用)

参数

名称 密钥 必需 类型 说明
长度
length True integer

设置密码的长度

包括小写
includeLowerCase boolean

设置是否应将小写字符包含在密码中

包括大写
includeUpperCase boolean

设置是否应在密码中包含大写字符

包括数字
includeNumbers boolean

设置是否应在密码中包含数字

包括符号
includeSymbols boolean

设置是否应将符号包含在密码中

排除字符
excludeCharacters string

指定要从密码中排除的字符列表

返回

实用工具 - 生成随机数 [已弃用]

生成符合提供的配置的随机数(已弃用)

参数

名称 密钥 必需 类型 说明
最小值
minValue integer

可选 - 设置生成的数字的最小值

最大值
maxValue integer

可选 - 设置生成的数字的最大值

返回

实用工具 - 获取文件扩展名 [已弃用]

获取提供的 filaname 的文件扩展名(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

要从中获取文件扩展名的文件名

案例
case string

设置提取的文件扩展名值(下限或上部)

返回

实用工具 - 获取日期和时间差异 [已弃用]

计算两个日期和时间之间的差异(已弃用)

参数

名称 密钥 必需 类型 说明
开始日期
startDateTime True string

要计算的时间段的开始日期(和可选时间)

结束日期
endDateTime True string

要计算的时间段的结束日期(和可选时间)

时间间隔
interval True string

要计算的间隔 - Year、Quarter、Month、Week、Day、Hour、Minute、Second、Millisecond

要排除的天数
daysToExclude string

将计算中要排除的天数指定为逗号分隔列表,例如:星期六、星期日

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

实用工具 - 计算日期 [已弃用]

通过添加或减去给定时间段来计算日期值(已弃用)

参数

名称 密钥 必需 类型 说明
日期
date True string

要计算的日期值

测量
measurement True string

设置用于计算的时间度量

操作
operation True string

设置作类型,添加或减去

时间间隔
interval True integer

设置在提供的“日期”值中添加或减去的时间量

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

实用工具 - 设置文本大小写的格式 [已弃用]

设置提供的文本(字符串)大小写(已弃用)

参数

名称 密钥 必需 类型 说明
文本
text True string

要设置格式的文本值

Action
action True string

要应用于提供的文本值的格式设置作

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

实用工具 - 转义 HTML [已弃用]

转义提供的 HTML 值(已弃用)

参数

名称 密钥 必需 类型 说明
HTML
html True string

要处理的 HTML 值

返回

实用工具 - 转换时区 [已弃用]

将提供的日期和时间值转换为另一个时区(已弃用)

参数

名称 密钥 必需 类型 说明
日期
date True string

要转换的日期和时间值

当前时区
currentTimeZone string

设置当前时区

新时区
newTimeZone True string

设置新的时区

区域性名称
cultureName string

更改用于处理请求的线程区域性

返回

实用工具 - 连接文本 [已弃用]

连接提供的文本值(已弃用)

参数

名称 密钥 必需 类型 说明
文本值
textList array of string

要连接的文本值的数组

分隔符
delimiter string

在串联的文本值之间放置的分隔符

剪裁结果
trimResult boolean

设置是否应从处理的文本值中剪裁空格

返回

实用工具 - 通过正则表达式删除项的数组 [已弃用]

使用正则表达式从 JSON 数组中删除项(已弃用)

参数

名称 密钥 必需 类型 说明
Data
data True string

要修改的 JSON 数据

正则表达式
regex True string

用于查找“Data”中的匹配项的正则表达式

路径
path string

使用 JSONPath 表达式选择“Data”中的特定节点

返回

实用工具 - 验证 GUID [已弃用]

验证提供的 GUID 是否有效(已弃用)

参数

名称 密钥 必需 类型 说明
GUID
guid True string

要验证的 GUID

返回

实用工具 - 验证 JSON [已弃用]

根据集架构(已弃用)验证提供的 JSON 数据(可选)

参数

名称 密钥 必需 类型 说明
JSON
json True string

要验证的 JSON 数据

Schema
schema string

可选 - 要应用于验证的 JSON 架构

返回

实用工具 - 验证 URL 可用性 [已弃用]

验证提供的 URL 是否可用(已弃用)

参数

名称 密钥 必需 类型 说明
URL
url True string

要验证的 URL,请在请求中包含 https:// 或 http://

验证 URL
validateURL boolean

设置在检查可用性之前是否应验证提供的“URL”

返回

实用工具 - 验证 URL 语法 [已弃用]

验证提供的 URL 是否具有有效的语法(已弃用)

参数

名称 密钥 必需 类型 说明
URL
url True string

要验证的 URL 语法,请在请求中包含 https:// 或 http://

返回

实用工具 - 验证电子邮件地址 [已弃用]

验证提供的电子邮件地址(已弃用)

参数

名称 密钥 必需 类型 说明
电子邮件地址
emailAddress True string

要验证的电子邮件地址

正则表达式
regex True string

用于验证的正则表达式

返回

将 HTML 插入 PDF [已弃用]

将提供的 HTML 插入 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

源文件的文件内容

HTML 数据
htmlData True string

将插入 PDF 文档中的 HTML

HTML 插入位置
htmlInsertLocation string

设置 PDF 提供的位置,应插入 HTML 数据,默认值为“前面”。

页码
htmlInsertLocationPage integer

设置要插入 HTML 数据的特定页面位置。

页面方向
pageOrientation string

设置页面作(横向或纵向)。

页面大小
pageSize string

设置输出 PDF 文档的页面大小,A4 是默认大小。

视区
viewPort string

设置用于呈现 HTML 的视区。

上边距
MarginTop double

设置上边距值 (mm)

下边距
MarginBottom double

设置底部边距值 (mm)

右边距
MarginRight double

设置右边距值(mm)

左边距
MarginLeft double

设置左边距值(mm)

解码 HTML 数据
decodeHtmlData boolean

设置是否应解码 HTML 数据字段中提供的数据。

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将 HTML 转换为 PDF [已弃用]

将提供的 HTML 或 Web URL 转换为 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
PDF 文件名
outputFilename True string

输出 PDF 文档的文件名

文件内容
fileContent byte

可选 - 源 HTML 文件的文件内容。

HTML 数据
htmlData string

可选 - 将转换为 PDF 文档的 HTML

HTML Url
htmlUrl string

可选 - 将转换为 PDF 文档的网页的 Web 地址

页面方向
pageOrientation string

设置页面作(横向或纵向)。

页面大小
pageSize string

设置输出 PDF 文档的页面大小,A4 是默认大小。

视区
viewPort string

设置用于呈现 HTML 的视区。

上边距
MarginTop double

设置上边距值(像素)

下边距
MarginBottom double

设置底部边距值(像素)

右边距
MarginRight double

设置右边距值(像素)

左边距
MarginLeft double

设置左边距值(像素)

启用书签
enableBookmarks boolean

启用或禁用自动创建 PDF 书签。

启用 JavaScript
enableJavaScript boolean

启用或禁用 javascript。

启用超链接
enableHyperlinks boolean

启用或禁用超链接。

创建 PDF 表单
createPdfForm boolean

设置是否应将 HTML 内容转换为 PDF 窗体。

解码 HTML 数据
decodeHtmlData boolean

设置是否应解码 HTML 数据字段中提供的数据。

CSS 类型
cssType string

设置是应使用标准样式表还是打印样式表进行 HTML 转换。

重复表标题
repeatTableHeader boolean

设置是否在每个分页符上重复表标题。 默认值为 true

重复表页脚
repeatTableFooter boolean

设置是否在每个分页符上重复表页脚。 默认值为 true

拆分图像
splitImages boolean

设置是否拆分图像

拆分文本行
splitTextLines boolean

设置是否拆分文本行

延迟
delay integer

设置接收的 HTML 与 JavaScript 加载到所有时间之间的延迟(以毫秒为单位)。

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将 HTML 转换为 Word [已弃用]

将提供的 HTML 或 Web URL 转换为 Microsoft Word 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
outputFilename True string

输出 DOCX 文档的文件名

文件内容
fileContent byte

可选 - 源 HTML 文件的文件内容。

HTML 数据
htmlData string

可选 - 将转换为 Word 文档的 HTML

HTML Url
htmlUrl string

可选 - 将转换为 Word 文档的网页的 Web 地址

页面方向
pageOrientation string

设置页面作(横向或纵向)。

页面大小
pageSize string

设置输出 Word 文档的页面大小,A4 是默认大小。

解码 HTML 数据
decodeHtmlData boolean

设置是否应解码 HTML 数据字段中提供的数据。

编码
encoding string

设置 HTML 的编码类型。

上边距
MarginTop double

设置上边距值 (pt. 默认值设置为 -1,其中减值不会更改现有页边距值。

下边距
MarginBottom double

设置下边距值 (pt. 默认值设置为 -1,其中减值不会更改现有页边距值。

右边距
MarginRight double

设置右边距值 (pt. 默认值设置为 -1,其中减值不会更改现有页边距值。

左边距
MarginLeft double

设置左边距值(pt. 默认值设置为 -1,其中减值不会更改现有页边距值。

合规性级别
WordComplianceLevel string

设置转换期间应用于 HTML 源的符合性级别

返回

将 HTML 页眉或页脚添加到 PDF [已弃用]

将 HTML 页眉、页脚或两者添加到指定的 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

源文件的文件内容

HTML 页眉/页脚
htmlHeaderFooter True string

要嵌入为文档中页眉或页脚的 HTML

位置
htmlHeaderFooterLocation True string

设置是否应将 HTML 添加到这两个位置的页眉和页脚。

跳过第一页
skipFirstPage boolean

设置是否在添加页眉/页脚时忽略第一页。

上边距
marginTop double

设置上边距值(mm)。

下边距
marginBottom double

设置底部边距值(mm)。

右边距
marginRight double

设置右边距值(mm)。

左边距
marginLeft double

设置左边距值(mm)。

应用于
applyTo string

设置 PDF 文档中要应用 HTML 页眉或页脚的页面。

页码
pageNumbers array of integer

指定应应用 HTML 页眉或页脚的页码,仅当“应用于”属性设置为“Specific”时,此属性才适用。

忽略页码
ignorePageNumbers array of integer

指定不应应用 HTML 页眉或页脚的页码,仅当“应用于”属性设置为“Specific”时,此属性才适用。

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
finalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将 JSON 转换为 Excel [已弃用]

将 JSON 转换为 Microsft Excel 文件(已弃用)

参数

名称 密钥 必需 类型 说明
输出文件名
outputFilename True string

输出文档的文件名

文件内容
fileContent byte

可选 - 源 JSON 文件的文件内容。

JSON 数据
jsonData string

可选 - 要转换为 Excel 文档的 JSON 数据

第一行
row integer

要写入到的第一行

第一列
column integer

要写入到的第一列

工作表名称
worksheetName string

将 JSON 数据添加到的工作表的名称

转换数字和日期
convertNumericAndDate boolean

自动分析数值和日期值,将单元格格式类别设置为“Number”或“Date”

日期格式
dateFormat string

设置日期和时间格式 - https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings

数字格式
numericFormat string

设置数字格式 - https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings

忽略 Null 值
ignoreNulls boolean

忽略包含 null 值的 JSON 属性。

标题 - 字体颜色
titleFontColour string

设置标题字体颜色

标题 - 字体粗体
isTitleBold boolean

将标题设置为粗体

标题 - 环绕文本
isTitleTextWrapped boolean

设置标题文本是否包装

忽略属性标题
ignoreAttributeTitles boolean

将 JSON 转换为 Excel 时忽略 JSON 属性的标题

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

将 PDF 转换为 JPG [已弃用]

将 PDF 文档转换为 JPG (已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源 PDF 文件的文件内容。

Filename
outputFilename string

输出 JPG 文件的文件名

图像质量
imageQuality integer

设置 1 到 100 之间的图像质量

决议
resolution integer

设置图像分辨率

解析单位
resolutionUnit string

设置分辨率单位

压缩颜色模式
compressionColourMode string

设置压缩颜色模式

压缩类型
compressionType string

设置压缩类型

增强压缩
enhancedCompression boolean

应用增强的压缩,进一步减小某些转换配置的图像大小

返回

将 PDF 转换为 PDFA [已弃用]

将 PDF 文档转换为 PDF/A 格式(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

源文件的文件内容

PDF/A 合规性级别
pdfaComplianceLevel string

设置 PDF/A 符合性级别,默认值为PDF_A_2A。

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将 PDF 转换为 PNG [已弃用]

将 PDF 文档转换为 PNG (已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源 PDF 文件的文件内容。

Filename
outputFilename string

输出 PNG 文件的文件名

进步
progressive boolean

设置渐进式图像呈现

Compression
compression string

设置压缩级别

决议
resolution integer

设置图像分辨率

位深度
bitDepth integer

设置位深度

返回

将 PDF 转换为 TIFF [已弃用]

将 PDF 文档转换为 TIFF (tiff) 格式(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源 PDF 文件的文件内容。

Filename
outputFilename string

输出 TIFF 文件的文件名

决议
resolution integer

设置图像分辨率

Compression
tiffCompression string

设置压缩类型

页面方向
pageOrientation string

设置 TIFF 文件的页面方向

跳过空白页
skipBlankPages boolean

设置是否应在转换时跳过空白页

返回

将 PDF 转换为 Word [已弃用]

将 PDF 文档转换为 Microsoft Word (docx) 格式(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
outputFilename True string

输出 DOCX 文档的文件名

文件内容
fileContent byte

源 PDF 文件的文件内容。

转换模式
mode string
识别项目符号
recognizeBullets boolean

返回

将 PDF 转换为图像 [已弃用]

将 PDF 文档转换为图像数组(PNG 或 JPG)(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源 PDF 文件的文件内容。

图像格式
imageFormat True string

设置输出图像文件的格式

文件名前缀
filenamePrefix string

输出图像文件的前缀文件名

决议
resolution integer

设置图像分辨率

返回

将 Word 转换为 PDF 表单 [已弃用]

将提供的 Word 文档(仅旧窗体控件)转换为 PDF 窗体文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源Microsoft Word 文件的文件名,文件扩展名是必需的:“file.doc”,而不是“file”

文件内容
fileContent True byte

源Microsoft Word 文件的文件内容

PDF 文件名
outputFilename True string

输出 PDF 文档的文件名

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将图像水印添加到 PDF - 高级 [已弃用]

使用标准选项将图像水印添加到指定的 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

源文件的文件内容

水印文件名
watermarkFilename True string

水印图像文件的文件名是必需的:“file.jpg”而不是“file”

水印文件内容
watermarkFileContent True byte

水印图像文件的内容

跳过第一页
skipFirstPage boolean

设置是否跳过将水印应用于第一页。

应用于
applyTo string

设置文档中要应用水印的位置。

页码
pageNumbers array of integer

指定应应用水印的页码,这仅在“应用于”属性设置为“特定”时适用。

忽略页码
ignorePageNumbers array of integer

指定不应应用水印的页码,仅当“应用于”属性设置为“Specific”时,此属性才适用。

水印不透明度
opacity float

文本水印的不透明度,有效值范围为 0.0+ 到 1.0,默认值为 0.7

旋转角度
rotationAngle float

设置图像水印的旋转角度(以度为单位)。

质量
quality integer

将图像水印的质量设置为 1 到 100。

X 偏移量
imageXOffset float

设置用于定位页面上水印图像的 X 偏移量。

Y 偏移量
imageYOffSet float

设置用于定位页面上水印图像的 Y 偏移量。

Scale
scale float

将倍数设置为减少(小于 1.0),或增加图像的大小(大于 1.0),例如:1.2 等于 120%,0.7 等于 70%。

添加到后台
addToBackground boolean

如果设置为“true”,水印图像将添加到页面的背景中。

水印 ID
watermarkId integer

替代并手动设置已应用水印的标识符

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将图像水印添加到 PDF [已弃用]

使用标准选项将图像水印添加到指定的 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

源文件的文件内容

水印文件名
watermarkFilename True string

水印图像文件的文件名是必需的:“file.jpg”而不是“file”

水印文件内容
watermarkFileContent True byte

水印图像文件的内容

跳过第一页
skipFirstPage boolean

设置是否跳过将水印应用于第一页。

方向
Orientation string

在文档中嵌入为水印的图像的方向

不透明度
Opacity float

文本水印的不透明度,有效值范围为 0.0+ 到 1.0,默认值为 0.7

水印 ID
watermarkId integer

替代并手动设置已应用水印的标识符

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将图像水印添加到 Word [已弃用]

将图像水印添加到指定的 word 文档Microsoft(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源Microsoft Word 文件的文件名,文件扩展名是必需的:“file.docx”,而不是“file”

文件内容
fileContent True byte

源Microsoft Word 文件的文件内容

水印文件名
watermarkFilename True string

水印图像文件的文件名是必需的:“file.jpg”而不是“file”

水印文件内容
watermarkFileContent True byte

水印图像文件的内容

区域性名称
cultureName string

更改用于处理请求的线程区域性

Scale
scale double

设置以图像分数表示的规模因子。 默认值为 1,有效值范围为 0 到 65.5

半透明
isSemiTransparent boolean

设置文本水印是否应为半透明

返回

将图像水印添加到图像 [已弃用]

将图像水印添加到提供的映像(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
filename True string

源文件的文件名,文件扩展名是必需的:“file.png”,而不是“file”

文件内容
fileContent True byte

源文件的文件内容

水印文件名
watermarkFilename True string

水印图像文件的文件名,文件扩展名是必需的:“file.png”,而不是“file”

水印文件内容
watermarkFileContent True byte

水印图像文件的内容

水印位置
watermarkPosition True string

图像水印在提供的图像上的位置

Y 偏移量
imageYOffSet integer

设置从图像顶部开始的垂直水印偏移量(以像素为单位)。 仅当“Watermark Position”属性设置为“Custom”时,此设置才适用。

X 偏移量
imageXOffset integer

设置从图像左侧开始的水平水印偏移量(以像素为单位)。 仅当“Watermark Position”属性设置为“Custom”时,此设置才适用。

旋转角度
rotationAngle float

设置图像水印的旋转角度(以度为单位)

不透明度
opacity float

图像水印的不透明度,有效值范围为 0.0+ 到 1.0,默认值为 0.7

返回

将文本替换为图像 [已弃用]

使用图像查找和替换 PDF 或 DOCX 文档中包含的文本(已弃用)

参数

名称 密钥 必需 类型 说明
文件类型
fileType string

选择源文档格式。

Filename
FileName string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
FileContent byte

源文件的文件内容

搜索文本
SearchText True string

要查找并替换为指定图像的文本

图像文件名
imageFilename True string

图像文件的文件名是必需的:“file.jpg”而不是“file”

图像文件内容
imageFileContent True byte

图像文件的内容

跳过第一页
skipFirstPage boolean

设置在搜索文本片段时是否忽略第一页。

应用于
applyTo string

设置文档中要搜索文本片段的页面

页码
pageNumbers array of integer

指定要搜索文本片段的页码,仅当“应用于”属性设置为“Specific”时,此属性才适用。

忽略页码
ignorePageNumbers array of integer

指定页码不搜索文本片段,仅当“应用于”属性设置为“Specific”时,此属性才适用。

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将文本水印添加到 PDF - 高级 [已弃用]

使用高级选项将文本水印添加到指定的 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

源文件的文件内容

文本
Text True string

要嵌入为文档中水印的文本。 添加回车控制字符(反斜杠 r)以手动将文本拆分为新行。

跳过第一页
skipFirstPage boolean

设置是否跳过将水印应用于第一页。

应用于
ApplyTo string

设置文档中要应用水印的位置。

页码
pageNumbers array of integer

指定应应用水印的页码,仅当“应用于”属性设置为“Specific”时,此代理才适用。

忽略页码
ignorePageNumbers array of integer

指定不应应用水印的页码,仅当“应用于”属性设置为“Specific”时,此属性才适用。

字体
Font string

应用于文本水印的字体,默认字体设置为 Arial。

文本颜色
TextColour string

应用于文本水印的 HTML 颜色,默认颜色设置为 #E81123。

文本大小
TextSize integer

应用于文本水印的字体大小,默认大小设置为 34。

不透明度
Opacity float

文本水印的不透明度,有效值范围为 0.0+ 到 1.0,默认值为 1.0

编码类型
EncodingType string

要应用于文本水印的编码类型。

水平对齐
HorizontalAlignment string

设置水印的水平对齐方式,默认值为 Center。

垂直对齐
VerticalAlignment string

设置水印的垂直对齐方式,默认值为 Center。

文本对齐方式
TextAlignment string

设置水印的文本对齐方式,默认值为 Center。

旋转角度
RotationAngle float

设置文本水印的旋转角度。

文字换行
TextWrap boolean

设置文本水印是否应自动换行。

文本换行宽度
TextWrapRowWidth double

设置水印设置为自动换行时应用的行宽。

自动缩放
AutoScale boolean

设置是否应自动调整文本大小以适应容器的宽度。

自动缩放文本宽度
AutoScaleWidth double

启用自动缩放时设置水印容器的宽度。

自动缩放文本高度
AutoScaleHeight double

启用自动缩放时设置水印容器的高度。

文本层
TextLayer boolean

设置水印是否应添加到顶部或底层。 如果为“True”,则水印将添加到底层。

Y 缩进
YIndent double

设置垂直水印缩进,从底部开始并重写 VerticalAlignment 属性。

X 缩进
XIndent double

设置水平水印缩进,从左侧开始并重写 HorizontalAlignment 属性。

作为图像应用
watermarkApplyAsImage boolean

设置文本水印是否应添加为文本或图像。

水印 ID
watermarkId integer

替代并手动设置已应用水印的标识符

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将文本水印添加到 PDF [已弃用]

使用标准选项将文本水印添加到指定的 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

源文件的文件内容

文本
Text True string

要嵌入为文档中水印的文本

跳过第一页
skipFirstPage boolean

设置是否跳过将水印应用于第一页。

方向
Orientation string

要嵌入为文档中水印的文本的方向

字体
Font string

应用于文本水印的字体,默认字体设置为 Arial。

文本颜色
TextColour string

应用于文本水印的 HTML 颜色,默认颜色设置为 #E81123。

文本大小
TextSize integer

应用于文本水印的字体大小,默认大小设置为 34。

不透明度
Opacity float

文本水印的不透明度,有效值范围为 0.0+ 到 1.0,默认值为 1.0

水印 ID
watermarkId integer

替代并手动设置已应用水印的标识符

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将文本转换为 PDF [已弃用]

将提供的文本转换为 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
PDF 文件名
outputFilename True string

输出 PDF 文档的文件名

文件内容
fileContent byte

可选 - 请提供源文件的文件内容和源文件名或文本数据。

文本数据
textData string

可选 - 请提供将转换为 PDF 文档的文本数据或源文件和源文件名的文件内容。

编码类型
textEncodingType string

用于文本转换的编码类型。

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将文档合并到 PDF [已弃用]

转换和合并提供给单个 PDF 文档的文档(已弃用)

参数

名称 密钥 必需 类型 说明
PDF 文件名
outputFilename True string

输出 PDF 文档的文件名

Filename
FileName True string

第 1 个源文件的文件名是必需的:“file.xlsx”而不是“file”

文件内容
fileContent True byte

源文件的文件内容

文件名 2
fileName2 True string

第二个源文件的文件名,文件扩展名是必需的:“file.xlsx”,而不是“file”

文件内容 2
fileContent2 True byte

第二个源文件的文件内容

文件名 3
fileName3 string

第三个源文件的文件名,文件扩展名是必需的:“file.xlsx”,而不是“file”

文件内容 3
fileContent3 byte

第三个源文件的文件内容

文件名 4
fileName4 string

第 4 个源文件的文件名是必需的:“file.xlsx”,而不是“file”

文件内容 4
fileContent4 byte

第 4 个源文件的文件内容

文件名 5
fileName5 string

第 5 个源文件的文件名,文件扩展名是必需的:“file.xlsx”,而不是“file”

文件内容 5
fileContent5 byte

第 5 个源文件的文件内容

文件名 6
fileName6 string

第 6 个源文件的文件名是必需的:“file.xlsx”,而不是“file”

文件内容 6
fileContent6 byte

第 6 个源文件的文件内容

文件名 7
fileName7 string

第 7 个源文件的文件名是必需的:“file.xlsx”,而不是“file”

文件内容 7
fileContent7 byte

第 7 个源文件的文件内容

文件名 8
fileName8 string

第 8 个源文件的文件名是必需的:“file.xlsx”而不是“file”

文件内容 8
fileContent8 byte

第 8 个源文件的文件内容

文件名 9
fileName9 string

第 9 个源文件的文件名是必需的:“file.xlsx”,而不是“file”

文件内容 9
fileContent9 byte

第 9 个源文件的文件内容

文件名 10
fileName10 string

第 10 个源文件的文件名是必需的:“file.xlsx”,而不是“file”

文件内容 10
fileContent10 byte

第 10 个源文件的文件内容

删除标记
removeDocumentMarkup boolean

设置 MS Office 文档注释和修订删除选项

PDF/A 合规
pdfaCompliance boolean

设置 PDF/A 符合性选项

PDF/A 合规性级别
pdfaComplianceLevel string

设置 PDF/A 符合性级别,默认值为PDF_A_2A。

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将文档数组合并到 PDF [已弃用]

将文档数组转换为单个 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
PDF 文件名
outputFilename True string

输出 PDF 文档的文件名

Filename
fileName string

文件的文件名

文件内容
fileContent byte

文件的文件内容

删除标记
removeDocumentMarkup boolean

设置 MS Office 文档注释和修订删除选项

PDF/A 合规
pdfaCompliance boolean

设置 PDF/A 符合性选项

PDF/A 合规性级别
pdfaComplianceLevel string

设置 PDF/A 符合性级别,默认值为PDF_A_2A。

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

将行添加到 Excel [已弃用]

将行添加到提供的 Excel 文件(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源Microsoft Excel 文件的文件内容

行数据
jsonData True string

要处理的 JSON 数据集,并将其作为行添加到提供的 Excel 文件中

从行插入
insertionRow integer

将在其中插入提供的数据的行号

从列插入
insertionColumn integer

将在其中插入提供的数据的列号

工作表名称
worksheetName string

指定特定工作表的名称

转换数字和日期
convertNumericAndDate boolean

自动分析数值和日期值,将单元格格式类别设置为“Number”或“Date”

日期格式
dateFormat string

设置日期和时间格式 - https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings

数字格式
numericFormat string

设置数字格式 - https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings

忽略属性标题
ignoreAttributeTitles boolean

将 JSON 转换为 Excel 时忽略 JSON 属性的标题

忽略 Null 值
ignoreNulls boolean

忽略包含 null 值的 JSON 属性。

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

将附件添加到 PDF [已弃用]

将一个或多个附件添加到提供的 PDF 文件(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源文件的文件内容

Filename
fileName string

文件的文件名

文件内容
fileContent byte

文件的文件内容

返回

平展 PDF [已弃用]

平展 PDF 文档或 PDF 表单(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源文件的文件内容

返回

拆分 PDF [已弃用]

将 PDF 文档拆分为多个 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

PDF 文件的文件内容

按类型拆分
splitByType True string

选择如何拆分文件

拆分配置
splitConfiguration True string

提供拆分配置

启用书签文件名
enableBookmarkFilenames boolean

按“BookmarkLevel”拆分时,将书签名称值追加到文件名

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

按文本拆分 PDF [已弃用]

将 PDF 文档按文本拆分为多个 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

PDF 文件的文件内容

拆分值
splitValue True string

提供用于执行拆分作的拆分值

Is 表达式
isExpression boolean

设置是否应将“拆分值”值作为正则表达式进行疏导,默认值为“false”

前缀文件名
prefixFilename boolean

设置是否应在输出文件名中使用表达式值。

拆分配置
splitPdfByTextType True string

选择拆分配置

拆分作
splitAction True string

选择拆分作,无论是在拆分之前、之后还是删除包含拆分值的页。

返回

按条形码拆分 PDF [已弃用]

按条形码拆分 PDF 文档,返回多个 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

PDF 文件的文件内容

条形码值
splitPdfByBarcodeValue string

可选 - 指定用于检测特定条形码的值

拆分配置
splitPdfByBarcodeType True string

选择拆分配置

拆分作
splitPdfByBarcodeAction True string

选择拆分作,无论是在拆分之前、之后还是删除包含拆分值的页。

置信度
barcodeReadConfidence string

设置条形码检测的置信度

追加条形码值
appendBarcodeValue boolean

可选 - 指定是否将找到的每个条形码的值追加到文件名的开头

返回

提取 Excel 工作表 [已弃用]

从提供的 Excel 文件中提取指定的工作表(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源Microsoft Excel 文件的文件内容

工作表名称
worksheetNames string

要提取的工作表名称的逗号分隔列表:Sales、Totals、Year to Date

工作表索引
worksheetIndexes string

要提取的工作表索引的逗号分隔列表:1,3,4

返回

搜索和替换文本 [已弃用]

查找和替换 PDF 或 DOCX 文档中包含的文本(已弃用)

参数

名称 密钥 必需 类型 说明
文件类型
fileType string

选择源文档格式。

Filename
FileName string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
FileContent byte

源文件的文件内容

搜索文本
SearchText True string

可选 - 要查找并替换为“替换文本”值的文本

Is 表达式
IsExpression boolean

设置是否应将“搜索文本”值作为正则表达式进行疏导,默认值为“false”

替换文本
ReplacementText string

用于将“搜索文本”文本替换为的文本

字体
Font string

要用于“替换文本”的字体的名称,默认字体为“Arial”

字号
FontSize integer

要用于“替换文本”的字体大小,默认大小为“16”

字体颜色
FontColour string

要用于“替换文本”的字体的 HTML 颜色,默认颜色为“#0000000”

背景色
BackgroundColour string

要用于“替换文本”的背景 HTML 颜色,默认颜色为“#FFFFFF”

下划线
Underline boolean

设置“替换文本”是否应带下划线,默认值为“false”

字距
WordSpacing float

要应用于“替换文本”的字距

行距
LineSpacing float

要应用于“替换文本”的行距

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

旋转图像 [已弃用]

按指定度旋转图像(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源映像文件的文件内容

旋转角度
rotationAngle float

可选 - 旋转图像的度数

预设旋转角度
presetRotationAngle string

可选 - 选择预设旋转角度

比例调整大小
resizeProportionally boolean

指定图像尺寸按比例调整为旋转矩形(角点)投影

背景色
backgroundColour string

启用“比例调整大小”时设置旋转图像的背景色

返回

映像清理 - 文档 [已弃用]

执行以基于文本的图像为中心的图像清理活动(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.png”,而不是“file”

文件内容
FileContent byte

源映像文件的文件内容

清理作
cleanUpType string

执行文件清理作,默认选项将自动旋转、自动桌面和自动取消指定提供的文件。

旋转
AutoRotate boolean

自动检测方向和旋转,使文本面向直立,默认启用此功能。

轮换置信度
AutoRotateConfidenceLevel integer

设置用于控制是否应用旋转的最小置信度百分比(0 到 100),默认值为 60。

Deskew
Deskew boolean

检测倾斜角度并旋转以删除该倾斜,这是默认启用的。

Despeckle
Despeckle boolean

自动检测斑点并删除它们,默认启用此功能。

调整亮度和对比度
AdjustBrightnessContrast boolean

此作会分析文档,并根据分析自动调整亮度和对比度,默认情况下会禁用此功能。

删除边框
RemoveBorder boolean

找到边框像素并删除文档中的像素,默认情况下禁用此像素。

平滑背景
SmoothBackground boolean

这仅适用于颜色和灰度文档。 此作会平滑背景色以消除或取消强调噪音,默认情况下禁用此干扰。

平滑对象
SmoothObjects boolean

这仅适用于位文档,它查看像素组,并在这些对象的边缘中查找隔离的凹凸和坑,并填充它们,默认情况下处于禁用状态。

删除点底纹
RemoveDotShading boolean

此作将从位文档中删除着色区域,默认情况下会禁用此作。

图像洗涤剂
ImageDetergent boolean

图像洗涤剂的工作原理是将类似颜色值的像素更改为中心颜色值,这会导致图像在图像出现的任何位置平滑显示,默认情况下会禁用。

平均筛选器
ApplyAverageFilter boolean

对文档执行 3x3 平均筛选器平滑作,将输出置于窗口中心,默认情况下禁用此作。

删除孔孔打孔
RemoveHolePunch boolean

检测并删除位文档中的孔打孔标记,默认情况下会禁用此标记。

Binarize
Binarize boolean

通过在实际执行二进制化之前分析输入数据来计算所有必要的参数。 该算法针对典型的文档图像进行了优化,该图像由较亮的背景上的深色文本组成。 它对于阴影、噪音和背景图像很可靠,默认情况下禁用此功能。

返回

更新 Excel 中的行 [已弃用]

更新提供的 Excel 文件中的指定行(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

要处理的 Excel 文件的 Base64 编码表示形式

行数据
jsonData True string

要处理的 JSON 数据集,并将其作为行添加到提供的 Excel 文件中

从行更新
updateRow True integer

提供的数据的行号将从

从列更新
updateColumn True integer

提供的数据的列号将从

工作表名称
worksheetName string

设置要更新的特定工作表的名称

转换数字和日期
convertNumericAndDate boolean

自动分析数值和日期值,将单元格格式类别设置为“Number”或“Date”

日期格式
dateFormat string

设置日期和时间格式 - https://docs.aspose.com/cells/net/list-of-supported-number-formats/

数字格式
numericFormat string

设置数字格式 - https://docs.aspose.com/cells/net/list-of-supported-number-formats/

忽略属性标题
ignoreAttributeTitles boolean

将 JSON 转换为 Excel 时忽略 JSON 属性的标题

忽略 Null 值
ignoreNulls boolean

忽略包含 null 值的 JSON 属性。

区域性名称
cultureName string

设置用于处理请求的线程区域性

返回

更新 Word - 删除页眉和页脚 [已弃用]

从提供的 Microsoft Word 文档中删除页眉和/或页脚(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源Microsoft Word 文件的文件内容

删除所有标头
removeAllHeaders boolean

设置为删除所有标头

删除所有页脚
removeAllFooters boolean

设置为删除所有页脚

页眉 - 第一页
removeFirstPageHeader boolean

设置为从第一页中删除页眉

页眉 - 偶数页
removeEvenPageHeader boolean

设置为从偶数页中删除页眉

页眉 - 奇数页
removeOddPageHeader boolean

设置为从奇数页中删除页眉

页脚 - 第一页
removeFirstPageFooter boolean

设置为从第一页中删除页脚

页脚 - 偶数页
removeEvenPageFooter boolean

设置为从偶数页中删除页脚

页脚 - 奇数页
removeOddPageFooter boolean

设置为从奇数页中删除页脚

返回

更新 Word - 添加页眉和页脚 [已弃用]

将 HTML 页眉和/或页脚添加到提供的 Microsoft Word 文档(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源Microsoft Word 文件的文件内容

页眉 - 所有页面
allPagesHeaderHtml string

要添加到所有页面的 HTML 标头

页脚 - 所有页面
allPagesFooterHtml string

要添加到所有页面的 HTML 页脚

页眉 - 第一页
firstPageHeaderHtml string

要添加到第一页的 HTML 标头

页眉 - 偶数页
evenPageHeaderHtml string

要添加到所有偶数页的 HTML 标头

页眉 - 奇数页
oddPageHeaderHtml string

要添加到所有奇数页的 HTML 标头

页脚 - 第一页
firstPageFooterHtml string

要添加到第一页的 HTML 页脚

页脚 - 偶数页
evenPageFooterHtml string

要添加到所有偶数页面的 HTML 页脚

页脚 - 奇数页
oddPageFooterHtml string

要添加到所有奇数页的 HTML 页脚

区域性名称
cultureName string

更改用于处理请求的线程区域性

返回

更新 Word - 目录 [已弃用]

更新提供的 Microsoft Word 文档中的“目录”(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源Microsoft Word 文件的文件名,文件扩展名是必需的:“file.docx”,而不是“file”

文件内容
fileContent True byte

源Microsoft Word 文件的文件内容

时区
timezone string

设置日期和时间处理的特定时区

区域性名称
cultureName string

更改用于处理请求的线程区域性

返回

更新 Word - 超链接 [已弃用]

查找和更新Microsoft Word 文档中包含的超链接(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName string

源Microsoft Word 文件的文件名,文件扩展名是必需的:“file.docx”,而不是“file”

文件内容
fileContent True byte

源文件的文件内容

搜索
searchOn True string

设置是否应在超链接文本或 URL 值上执行搜索

搜索值
searchValue True string

要查找的超链接文本或 URL 值

Is 表达式
isExpression boolean

设置是否应将“搜索值”值计算为正则表达式,默认值为“false”

文本当前值
hyperlinkLabelValueCurrent string

要替换的文本值,留空以替换整个值

文本新值
hyperlinkLabelValueNew string

要设置的新值

URL 当前值
hyperlinkUrlValueCurrent string

要替换的 URL 值,留空以替换整个值

URL 新值
hyperlinkUrlValueNew string

要设置的新 URL 值

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

比较 Word 文档 [已弃用]

比较Microsoft Word 和 PDF 文档之间的差异(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容 - 一个
fileContentOne True byte

要比较的第一个Microsoft Word 或 PDF 文件的文件内容。

文件内容 - 两个
fileContentTwo True byte

要比较的第二个Microsoft Word 或 PDF 文件的文件内容。

作者
author string

设置用于表示输出文档中差异的作者的名称。

忽略格式设置
ignoreFormatting boolean

指定是否忽略文档格式差异

不区分大小写
caseInsensitive boolean

指定是否将文档中的差异作为不区分大小写

忽略注释
ignoreComments boolean

指定是否比较注释中的差异

忽略表
ignoreTables boolean

指定是否比较表中包含的数据的差异

忽略字段
ignoreFields boolean

指定是否比较字段中的差异。 默认情况下,字段

忽略脚注
ignoreFootnotes boolean

指定是否比较脚注和尾注的差异

忽略文本框
ignoreTextboxes boolean

指定是否比较文本框中所包含的数据的差异

忽略页眉和页脚
ignoreHeadersAndFooters boolean

指定是否比较页眉和页脚中包含的数据的差异

返回

添加到存档 [已弃用]

将所提供的文件添加到存档文件(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
outputFilename True string

输出 ZIP 包的文件名

Filename
fileName string

文件的文件名

文件内容
fileContent byte

文件的文件内容

密码
Password string

设置密码以保护和加密存档(ZIP 文件)

Encryption
encryption string

设置将应用于受密码保护的存档的加密级别(ZIP 文件)

编码
encoding string

设置编码类型。

返回

添加页码 [已弃用]

向提供的 PDF 文档添加页码(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

源文件的文件内容

起始页
StartPage integer

设置从中开始添加页码的页面。

起始编号
StartNumber integer

设置添加到文档中的页码的起始编号。

页码格式
PageNumberFormat string

设置添加到文档中的页码的格式,其中 [PageNumber] 被当前页码替换,[TotalPages] 将替换为总页数。

水平对齐
HorizontalAlignment string

设置添加到文档中的页码的水平对齐方式,默认值为 Center。

自定义数字格式
CustomNumberFormat string

设置自定义数字格式,例如“{0:00000}”将生成 00001

边距 - 顶部
MarginTop double

设置上边距值(pt)。 默认值设置为 20。

边距 - 右
MarginRight double

设置右边距值(pt)。 默认值设置为 20。

边距 - 底部
MarginBottom double

设置底部边距值(pt)。 默认值设置为 20。

边距 - 左侧
MarginLeft double

设置左边距值(pt)。 默认值设置为 20。

添加到后台
AddToBackground boolean

设置是否应将页码添加到 PDF 文档的顶部或底层。 默认设置 (false) 将页码添加到顶层。

字体
Font string
字体颜色
FontColour string

设置字体的 HTML 颜色,默认颜色设置为 #000000。

字号
FontSize integer

设置字体大小,默认大小设置为 14。

不透明度
Opacity float

设置页码的不透明度,有效值范围为 0.0+ 到 1.0,默认值为 1.0

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

禁用修订 [已弃用]

禁用提供的 Microsoft Word 文档的修订(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源Microsoft Word 文件的文件名,文件扩展名是必需的:“file.docx”,而不是“file”

文件内容
fileContent True byte

源Microsoft Word 文档的文件内容

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

签名 PDF [已弃用]

将数字签名应用于提供的 PDF 文档(已弃用)

参数

名称 密钥 必需 类型 说明
证书类型
certificateTypeParameter string

设置证书类型

操作
operation dynamic

请求对象,请参阅架构定义:DtoSignPdf

返回

管理修订 [已弃用]

处理提供的 Microsoft Word 文档中的修订(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源Microsoft Word 文件的文件名,文件扩展名是必需的:“file.docx”,而不是“file”

文件内容
FileContent True byte

源Microsoft Word 文件的文件内容

接受插入
acceptInsertions string

设置是接受还是拒绝插入

接受删除
acceptDeletions string

设置是接受还是拒绝删除

接受格式更改
acceptFormatChanges string

设置是接受还是拒绝格式更改

接受移动
acceptMovements string

设置是接受还是拒绝内容移动

删除批注
removeComments boolean

设置是否删除批注

区域性名称
cultureName string

更改用于处理请求的线程区域性

返回

翻转图像 [已弃用]

翻转提供的图像(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源映像文件的文件内容

方向
flipOrientation True string

设置方向以翻转提供的图像

返回

获取 PDF 文本层 [已弃用]

获取提供的 PDF 文档的文本层(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
FileContent byte

源文件的文件内容

起始页
StartPage integer

设置页码以开始从中提取文本层。

结束页
EndPage integer

设置页码以结束从中提取文本层。 默认值设置为提供的 PDF 文档的最后一页。

编码类型
TextEncodingType string

用于文本提取的编码类型。

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

获取 PDF 文档信息 [已弃用]

获取 PDF 文档信息(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent True byte

源文件的文件内容

返回

获取 PDF 表单数据 [已弃用]

从 PDF 表单中提取 PDF 表单数据(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
FileContent byte

源文件的文件内容

操作 ID
OperationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

获取修订 [已弃用]

获取提供的 Microsoft Word 文档的所有修订(修订和注释)(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源Microsoft Word 文件的文件内容

包括批注
includeComments boolean

设置是否应在修订结果中包含注释

区域性名称
cultureName string

更改用于处理请求的线程区域性

返回

获取映像信息 [已弃用]

获取图像信息(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源映像文件的文件内容

简化的 Lat/长格式
simplifiedLatLongFormat boolean

以带格式的字符串返回纬度和经度,例如“45° 26”21“N”

返回

获取电子邮件信息 [已弃用]

获取有关提供的电子邮件的详细信息(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

电子邮件的文件内容

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

获取电子邮件附件 [已弃用]

从提供的电子邮件中提取附件并返回文件数组(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源文件的文件名,文件扩展名是必需的:“file.eml”或“file.msg”,而不是“file”

文件内容
fileContent True byte

电子邮件的文件内容

获取内联附件
getInlineAttachments True boolean

设置是否提取内联附件

返回

获取订阅状态 - Flowr 和 Vertr [已弃用]

获取 Encodian 订阅的状态(已弃用)

返回

获取订阅状态 - Trigr [已弃用]

获取 Encodian 订阅的状态(已弃用)

返回

裁剪图像 [已弃用]

使用边框值或矩形裁剪图像(已弃用)

参数

名称 密钥 必需 类型 说明
裁剪类型
cropTypeParameter string

设置裁剪类型作

操作
operation dynamic

请求对象,请参阅架构定义:DtoCropImage

返回

解锁 PDF 文档 [已弃用]

解密和删除 PDF 文档的密码保护(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

源文件的文件内容

密码
password True string

用于解锁 PDF 文档的密码

操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

设置 PDF 文档权限 [已弃用]

设置分配给 PDF 文档的特权(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.pdf”,而不是“file”

文件内容
fileContent byte

源文件的文件内容

特权
pdfPrivileges string

设置分配给 PDF 文档的权限

集会
pdfPrivilegesAllowAssembly boolean
复制
pdfPrivilegesAllowCopy boolean
填写窗体
pdfPrivilegesAllowFillIn boolean
Print
pdfPrivilegesAllowPrint boolean
屏幕阅读器
pdfPrivilegesAllowScreenReaders boolean
修改内容
pdfPrivilegesAllowModifyContents boolean
修改批注
pdfPrivilegesAllowModifyAnnotations boolean
操作 ID
operationId string

高级 - 设置上一个 Encodian作的标识符,请在使用之前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

读取 QR 码 - 图像 [已弃用]

从提供的图像读取 QR 码(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源映像文件的文件内容

图像格式
barcodeImageFormat True string

选择提供的 QR 码图像的图像格式

置信度
barcodeReadConfidence string

设置条形码检测的置信度

删除控制字符
barcodeRemoveControlChars boolean

设置是否应删除识别的控制字符

返回

读取 QR 码 - 文档 [已弃用]

从提供的文档中读取 QR 码(已弃用)

参数

名称 密钥 必需 类型 说明
文件类型
fileType string

选择源文档格式。

文件内容
FileContent byte

源文件的文件内容

置信度
barcodeReadConfidence string

设置条形码检测的置信度

起始页
startPage integer

设置从中开始读取的页码

结束页
endPage integer

设置页码以结束阅读

删除控制字符
barcodeRemoveControlChars boolean

设置是否应删除识别的控制字符

返回

读取条形码 - 图像 [已弃用]

从提供的图像中读取条形码(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源映像文件的文件内容

图像格式
barcodeImageFormat True string

选择提供的条形码图像的图像格式

置信度
barcodeReadConfidence string

设置条形码检测的置信度

删除控制字符
barcodeRemoveControlChars boolean

设置是否应删除识别的控制字符

返回

读取条形码 - 文档 [已弃用]

从提供的文档读取条形码(已弃用)

参数

名称 密钥 必需 类型 说明
文件类型
fileType string

选择源文档格式。

文件内容
FileContent byte

源文件的文件内容

置信度
barcodeReadConfidence string

设置条形码检测的置信度

质量
barcodeReadQuality string

设置条形码检测的质量级别

起始页
startPage integer

设置从中开始读取的页码

结束页
endPage integer

设置页码以结束阅读

删除控制字符
barcodeRemoveControlChars boolean

设置是否应删除识别的控制字符

返回

调整 PDF 大小 [已弃用]

调整 PDF 文档的大小(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
FileContent True byte

源文件的文件内容

页面大小
pageSize True string

设置要应用于提供的 PDF 文件的新页面大小

起始页
startPage integer

设置页码以开始调整大小

结束页
EndPage integer

设置页码以结束调整大小

宽度
customWidth float

设置自定义宽度,仅在设置“自定义”页面大小时才应用

高度
customHeight float

设置自定义高度,仅在设置“自定义”页面大小时才应用

填充底部
paddingBottom double

按百分比设置 PDF 文档的底部填充(默认值为 0%)

填充顶部
paddingTop double

按百分比设置 PDF 文档的顶部填充(默认值为 0%)

向左填充
paddingLeft double

按百分比设置 PDF 文档的左填充(默认值为 0%)

向右填充
paddingRight double

按百分比设置 PDF 文档的右填充(默认值为 0%)

返回

调整图像大小 [已弃用]

重设图像大小并压缩提供的图像(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.png”,而不是“file”

文件内容
FileContent True byte

源映像文件的文件内容

调整类型大小
ImageResizeType True string

设置图像的大小是应调整为比率还是特定尺寸。

调整百分比
ResizePercentage integer

对于调整大小百分比作 - 设置图像应按大小进行解码或增加的百分比。

图像宽度
ImageWidth integer

对于特定的调整大小作 - 设置图像的特定宽度(以像素为单位)

图像高度
ImageHeight integer

对于特定的调整大小作 - 设置图像的特定高度(以像素为单位)

保持纵横比
MaintainAspectRatio boolean

对于特定的调整大小作 - 如果为 true,将自动设置与提供的图像宽度相关的图像高度。

图像分辨率
ImageResolution integer

(可选)指定图像分辨率,默认情况下将使用当前图像分辨率

返回

转换 CAD [已弃用]

将 CAD 文件转换为其他文档格式(已弃用)

参数

名称 密钥 必需 类型 说明
输出格式
outputFormatParameter string

设置输出文件类型

转换
conversion dynamic

请求对象,请参阅架构定义:DtoConvertCad

返回

转换 Excel [已弃用]

将Microsoft Excel 文档转换为另一种文档格式(已弃用)

参数

名称 密钥 必需 类型 说明
输出格式
outputFormatParameter string

设置输出文件类型

转换
conversion dynamic

请求对象,请参阅架构定义:DtoConvertExcel

返回

转换 PowerPoint [已弃用]

将 Microsoft PowerPoint 文档转换为另一种文档格式(已弃用)

参数

名称 密钥 必需 类型 说明
输出格式
outputFormatParameter string

设置输出文件类型

转换
conversion dynamic

请求对象,请参阅架构定义:DtoConvertPowerPoint

返回

转换 Visio [已弃用]

将 Microsoft Visio 文档转换为另一种文档格式(已弃用)

参数

名称 密钥 必需 类型 说明
输出格式
outputFormatParameter string

设置输出文件类型

转换
conversion dynamic

请求对象,请参阅架构定义:DtoConvertVisio

返回

转换 Word [已弃用]

将 Microsoft Word 文档转换为其他文档格式(已弃用)

参数

名称 密钥 必需 类型 说明
输出格式
outputFormatParameter string

设置输出文件类型

转换
conversion dynamic

请求对象,请参阅架构定义:DtoConvertWord

返回

转换为 PDF [已弃用]

将文档转换为 PDF 或 PDF/A 格式(已弃用)

参数

名称 密钥 必需 类型 说明
Filename
FileName True string

源文件的文件名,文件扩展名是必需的:“file.xlsx”,而不是“file”

文件内容
fileContent True byte

源文件的文件内容

PDF 文件名
outputFilename True string

输出 PDF 文档的文件名

删除标记
removeDocumentMarkup boolean

设置 MS Office 文档注释和修订删除选项

PDF/A 合规
pdfaCompliance boolean

设置 PDF/A 符合性选项

PDF/A 合规性级别
pdfaComplianceLevel string

设置 PDF/A 符合性级别,默认值为PDF_A_2A。

生成书签
GenerateBookmarks boolean

设置是否应为转换为 PDF 的 Word 文档自动创建书签Microsoft。

区域性名称
CultureName string

更改用于处理请求的线程区域性。

返回文件
FinalOperation boolean

高级 - 返回已处理的文件(文件内容),而不是仅返回作 ID,请在使用前查看 - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID

返回

转换图像格式 [已弃用]

转换提供的图像的格式(已弃用)

参数

名称 密钥 必需 类型 说明
文件内容
fileContent True byte

源映像文件的文件内容

当前图像格式
currentImageFormat True string

选择当前图像文件格式。

新建图像格式
newImageFormat True string

选择新的图像文件格式。

返回

转换电子邮件 [已弃用]

将电子邮件转换为 PDF (已弃用)

参数

名称 密钥 必需 类型 说明
Filename
fileName True string

源文件的文件名,文件扩展名是必需的:“file.msg”,而不是“file”

文件内容
fileContent True byte

源文件的文件内容

合并附件
mergeAttachments boolean

设置是否应自动转换附件并将其与 output.pdf 合并

生成书签
generateBookmarks boolean

设置是否应为转换为 PDF 的 Word 文档自动创建书签Microsoft。

PDF/A 合规
pdfaCompliance boolean

设置 PDF/A 符合性选项

PDF/A 合规性级别
pdfaComplianceLevel string

设置 PDF/A 符合性级别,默认值为PDF_A_2A。

区域性名称
cultureName string

更改用于处理请求的线程区域性。

返回

触发器

当用户运行 Trigr [已弃用]

管理订阅 Encodian Trigr Webhook (已弃用)

当用户运行 Trigr [已弃用]

管理订阅 Encodian Trigr Webhook (已弃用)

参数

名称 密钥 必需 类型 说明
Title
title True string

Encodian Trigr 的标题

Description
description string

描述此流的用途

返回

名称 路径 类型 说明
站点地址
site string

SharePoint 网站地址

库/列表 ID
libraryId string

源 SharePoint 库/列表 ID

库/列表名称
libraryName string

源 SharePoint 库/列表名称

Item
item integer

所选文档/项 ID,或项数组中的第一个选定文档/项 ID。

items
items array of integer

documentIds

窗体字段
formFields string

用户提供的动态表单数据

用户电子邮件地址
userEmail string

触发此流的用户的电子邮件地址

文件标识符
fileIdentifier string

文件标识符数组中的单个文件标识符或第一个文件标识符

fileIdentifiers
fileIdentifiers array of string

文件标识符

定义

DocumentArray

名称 路径 类型 说明
Filename
fileName string

文件的文件名

文件内容
fileContent byte

文件的文件内容

DtoResponseAddAttachmentsToPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseAddHtmlHeaderFooter

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseAddHtmlHeaderFooterWord

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

文件内容
FileContent byte

已处理的文档。

DtoResponseAddImageWatermark

名称 路径 类型 说明
水印 ID
watermarkId integer

应用于水印的标识符

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseAddImageWatermarkAdv

名称 路径 类型 说明
水印 ID
watermarkId integer

应用于水印的标识符

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseAddImageWatermarkToImage

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseAddImageWatermarkWord

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseAddPageNumbers

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseAddRowsToExcel

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

文件内容
FileContent byte

已处理的文档。

DtoResponseAddTextWatermark

名称 路径 类型 说明
水印 ID
watermarkId integer

应用于水印的标识符

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseAddTextWatermarkAdv

名称 路径 类型 说明
水印 ID
watermarkId integer

应用于水印的标识符

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseAddTextWatermarkToImage

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseAddTextWatermarkWord

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseAesDecryption

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseAesEncryption

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseArrayAddItems

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseArrayContainsValue

名称 路径 类型 说明
结果
result boolean

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseArrayConvertToJson

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseArrayCountItems

名称 路径 类型 说明
结果
result integer

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseArrayGetItems

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseArrayRemoveDuplicates

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseArrayRemoveItems

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseArrayRemoveItemsRegex

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseArrayReplaceValues

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseArrayReverseItems

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseBasicConversion

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseCalculateDate

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseCleanString

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseCompareText

名称 路径 类型 说明
结果
result boolean

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseCompareWordDocuments

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseCompressPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseCompressPowerPoint

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseConcatenateText

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseConvertCad

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseConvertExcel

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseConvertJsonToExcel

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseConvertMailMessage

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseConvertPdfToImages

名称 路径 类型 说明
文档
documents array of DocumentArray

从源 PDF 生成的图像数组

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseConvertPdfToJpg

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseConvertPdfToPng

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseConvertPdfToTiff

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseConvertPdfToWord

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseConvertPowerPoint

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseConvertTimeZone

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseConvertToPdfA

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseConvertVisio

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseConvertWord

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseCreateBarcode

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseCreateGuid

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseCreateHMAC

名称 路径 类型 说明
HMAC
hmac string

计算的 HMAC

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseCreateHashCode

名称 路径 类型 说明
哈希代码
HashCode string

计算的哈希代码

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseCreateQrCode

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseCropImage

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

文件内容
FileContent byte

已处理的文档。

DtoResponseDeleteRowsFromExcel

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

文件内容
FileContent byte

已处理的文档。

DtoResponseDisableTrackedChanges

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseEnableTrackedChanges

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseEncodianSendToFiler

名称 路径 类型 说明
响应
response string

Encodian Filer 返回的 JSON 响应

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseEscapeHtml

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseExtractAllTextInstancesBetweenValues

名称 路径 类型 说明
结果
result array of string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseExtractAttachmentsFromPdf

名称 路径 类型 说明
文档
documents array of DocumentArray

从源 PDF 中提取的文档数组

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseExtractEmailAddressesFromText

名称 路径 类型 说明
结果
result array of string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseExtractExcelWorksheets

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

文件内容
FileContent byte

已处理的文档。

DtoResponseExtractFromArchive

名称 路径 类型 说明
文档
documents array of DocumentArray

从提供的存档中提取的文档数组

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseExtractImage

名称 路径 类型 说明
映像
Images array of DocumentArray

从 PDF 中提取的图像数组

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseExtractTextBetweenValues

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseExtractTextRegion

名称 路径 类型 说明
简单文本区域结果
TextRegionResultsSimple string

文本区域的集合以简化格式生成

文本区域结果
TextRegionResults array of TextRegionResult

文本区域结果的集合。

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseExtractUrlsFromText

名称 路径 类型 说明
结果
result array of string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseFillPdfForm

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseFlattenPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseFlipImage

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

文件内容
FileContent byte

已处理的文档。

DtoResponseFormatDate

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseFormatTextCase

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseGeneratePassword

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseGenerateRandomNumber

名称 路径 类型 说明
结果
result integer

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseGetDateTimeDifference

名称 路径 类型 说明
结果
result integer

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseGetEmailAttachments

名称 路径 类型 说明
文档
documents array of DocumentArray

从源电子邮件中提取的文档数组

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseGetEmailInfo

名称 路径 类型 说明
Subject
subject string

电子邮件的主题

正文 - 文本
bodyText string

电子邮件的内容作为文本

正文 - HTML
bodyHtml string

电子邮件的内容为 HTML

to string

“To”属性中电子邮件地址的逗号分隔列表

To - Array
toArray array of string

从“To”属性获取的电子邮件地址数组

Cc
cc string

从“抄送”属性获取的电子邮件地址的逗号分隔列表

Cc - 数组
ccArray array of string

从“抄送”属性获取的电子邮件地址数组

Bcc
bcc string

从“密件抄送”属性获取的电子邮件地址的逗号分隔列表

密件抄送 - 数组
bccArray array of string

从“密件抄送”属性获取的电子邮件地址数组

来自
from string

从“From”属性获取的电子邮件地址

Sent
sent date-time

发送电子邮件的日期和时间

Priority
priority string

电子邮件的优先级

Sensitivity
sensitivity string

电子邮件的敏感度

带有附件
hasAttachments boolean

指示电子邮件是否包含附件

文件大小(MB)
fileSize string

电子邮件的大小(MB)

消息 ID
messageId string

电子邮件的邮件 ID

Headers
headers array of string

从电子邮件获取的标头数组

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseGetFileExtension

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseGetImageInfo

名称 路径 类型 说明
图像格式
imageFormat string

图像的文件格式

文件大小(MB)
fileSize string

提供的映像的大小(以 MB 为单位)

宽度
width double

图像的宽度(像素)

高度
height double

图像的高度(像素)

方向
orientation string

图像的方向

每个像素的位数
bitsPerPixel integer

每个像素计数的图像位数

水平分辨率
horizontalResolution double

水平图像分辨率(DPI)

垂直行业解决方案
verticalResolution double

垂直图像分辨率(DPI)

具有 EXIF 数据
hasExifData boolean

确认图像是否包含 EXIF 数据

EXIF 数据(JSON)
exifDataJson string

图像 EXIF 数据作为 JSON 字符串提供

具有 XMP 数据
hasXmpData boolean

确认映像是否包含 XMP 数据

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseGetPdfDocumentInfo

名称 路径 类型 说明
页数
NumberOfPages integer

提供的 PDF 文档中的页数

文件大小(MB)
FileSize string

提供的 PDF 文档的大小(以 MB 为单位)

作者
Author string

PDF 属性中设置的 PDF 作者

Creator
Creator string

PDF 属性中设置的 PDF 创建者

Producer
Producer string

PDF 属性中设置的 PDF 生成者

Title
Title string

PDF 属性中设置的 PDF 标题

Subject
Subject string

PDF 属性中设置的 PDF 主题

关键字
Keywords string

PDF 属性中设置的 PDF 关键字

宽度
Width double

PDF 文档的宽度(磅)

高度
Height double

PDF 文档的高度(磅)

方向
Orientation string

PDF 文档的方向

创建日期
CreatedDate date-time

PDF 属性中设置的 PDF 的创建日期

修改日期
ModifiedDate date-time

PDF 属性中设置的 PDF 的上次修改日期

PDF 格式
PDFFormat string

PDF 的格式

符合 PDFA
IsPDFACompliant boolean

指示提供的 PDF 是否符合 PDF/a 标准

符合 PDFUA
IsPDFUACompliant boolean

指示提供的 PDF 是否符合 PDF/ua 标准

Is Encrypted
IsEncrypted boolean

指示提供的 PDF 是否符合加密

具有文本层
HasTextLayer boolean

指示提供的 PDF 是否具有文本层

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseGetPdfFormData

名称 路径 类型 说明
表单数据
Form Data string
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseGetPdfTextLayer

名称 路径 类型 说明
文本层
TextLayer string

从 PDF 文档中提取的文本层。

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseGetRowsFromExcel

名称 路径 类型 说明
行数据
rowData string

以 JSON 格式字符串形式返回的行数据

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseGetTextFromWord

名称 路径 类型 说明
文本
text string

从提供的单词文档中提取的文本

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseGetTrackedChanges

名称 路径 类型 说明
JSON - 修订
trackedChangesJson string

包含修订详细信息的 JSON 格式字符串

JSON - 注释
commentsJson string

包含注释的 JSON 格式字符串

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseHtmlToPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseHtmlToWord

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseImageCleanUpDoc

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseImageCleanUpPhoto

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseImageCompress

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseImageConvertFormat

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseImageExtractText

名称 路径 类型 说明
文本
Text string

从图像中提取的文本层。

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseImageRemoveExifTags

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseImageResize

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseInsertHtmlToPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseManageTrackedChanges

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseMergeArrayOfDocumentsToPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseMergeArrayOfDocumentsToWord

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseMergeArrayOfExcelDocuments

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseMergeDocumentsToPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseMergeExcelRows

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseMergePresentations

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseMgmtGetSubscriptionStatus

名称 路径 类型 说明
可用操作
availableActionsMonth integer

当前日历月剩余的作数。

可用作 - 实用工具
availableActionsMonthDec double

当前日历月剩余的实用工具作数(小数)。

已启用订阅
subscriptionEnabled boolean

指示 Encodian 订阅是启用或禁用的。

订阅级别
subscriptionLevel string

详细说明当前的 Encodian 订阅级别。

每月作
monthlyActions integer

详细说明当前 Encodian 订阅级别的每月允许的作。

过期日期
expiryDate date-time

Encodian 订阅的到期日期和时间。

计费间隔
billingInterval string

详细说明当前计费间隔(每月或每年)。

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseOcrPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseParseCsv

名称 路径 类型 说明
CSV 数据
csvData string

JSON 格式分析的 CSV 数据。

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseParseHtmlTable

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponsePopulateExcel

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponsePopulatePowerPoint

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponsePopulateWordDocument

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseReadBarcodeFromDocument

名称 路径 类型 说明
条形码
barcodes array of string

检测到的条形码的值

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseReadBarcodeFromImage

名称 路径 类型 说明
价值
Value string

条形码的值

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseReadQrCodeFromDocument

名称 路径 类型 说明
QR 码
qrCodes array of string

检测到 QR 码的值

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseReadQrCodeFromImage

名称 路径 类型 说明
价值
Value string

QR 码的值

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseRedactPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseRegexSearchText

名称 路径 类型 说明
匹配
matches array of string

在提供的文本中找到的匹配项

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseRemoveDiacritics

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseRemoveHeaderFooterWord

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

文件内容
FileContent byte

已处理的文档。

DtoResponseRemoveTextBetweenValues

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseRemoveWatermarksFromPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseRemoveWatermarksFromWord

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseRepairPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseReplaceValueWithRegex

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseReplaceValueWithText

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseResizePdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseRotateImage

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

文件内容
FileContent byte

已处理的文档。

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseSearchAndReplaceText

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseSearchAndReplaceTextWithImage

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseSecurePdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseSecureWordDocument

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseSignPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseSplitDocument

名称 路径 类型 说明
文档
documents array of DocumentArray

要处理的文档数组

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseSplitPdfByBarcode

名称 路径 类型 说明
文档
documents array of DocumentArray

从源 PDF 拆分的文档数组

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseSplitPdfByText

名称 路径 类型 说明
文档
documents array of DocumentArray

从源 PDF 拆分的文档数组

HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseSplitText

名称 路径 类型 说明
结果
result array of string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseTextContainsValue

名称 路径 类型 说明
结果
result boolean

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseTextToPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseTrimText

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseUnescapeHtml

名称 路径 类型 说明
结果
result string

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseUnlockPdf

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseUpdateRowsInExcel

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

文件内容
FileContent byte

已处理的文档。

DtoResponseUpdateWordTableOfContents

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseValidateEmailAddress

名称 路径 类型 说明
结果
result boolean

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseValidateGuid

名称 路径 类型 说明
结果
result boolean

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseValidateJson

名称 路径 类型 说明
结果
result boolean

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseValidateUrlAvailability

名称 路径 类型 说明
结果
result boolean

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseValidateUrlSyntax

名称 路径 类型 说明
结果
result boolean

请求的响应值

HTTP 状态代码
httpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
httpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
operationId string

分配给此作的唯一 ID。

Errors
errors array of string

如果发生错误,错误消息数组。

操作状态
operationStatus string

指示作是否已完成、已排队还是失败。

DtoResponseWordToPdfForm

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

DtoResponseZipArrayOfDocuments

名称 路径 类型 说明
HTTP 状态代码
HttpStatusCode integer

响应的 HTTP 状态代码。

HTTP 状态消息
HttpStatusMessage string

响应的 HTTP 状态消息。

操作 ID
OperationId string

分配给此作的唯一 ID。

Errors
Errors array of string

如果发生错误,错误消息数组。

操作状态
OperationStatus string

指示作是否已完成、已排队还是失败。

Filename
Filename string

文档的文件名。

文件内容
FileContent byte

已处理的文档。

TextRegionResult

名称 路径 类型 说明
Name
Name string

分配给文本区域的名称

文本
Text string

通过 OCR 从指定区域提取的文本

页码
PageNumber integer

从中提取文本的页数