APIs

API 允许您访问“管理包”菜单中提供的服务并与之交互。您可以在设计编码自动化时使用这些 API。访问编码自动化，了解编码自动化以及如何使用 API 设计这些自动化。

注意：使用“转到定义”(F12) 允许您访问特定服务的 UiPath API 定义。我们建议在实施编码自动化时仅依赖直接公开的 API。未直接与服务一起公开的其他 API 如有更改，恕不另行通知。

重载

API 通常具有重载，这意味着它们为同一方法的多个版本提供不同的参数选项。重载允许您根据特定要求自定义 API 的行为。例如，用户界面自动化 API 可能具有接受超时参数的重载，以指定在结束执行之前等待用户界面元素出现的最长时间。

通过使用具有各自重载的 API，您可以轻松实现所需的自动化逻辑和行为。

系统 API

API	描述
添加数据行	将数据行添加到指定的数据表中。
AddQueueItem	在 Orchestrator 队列中添加新项目。
添加事务项目	在队列中添加新项目并启动事务。
附加行	将指定字符串附加到文件，如果文件不存在，则创建该文件。
BulkAddQueueItems	将指定 `DataTable` 中的项目集合添加到 Orchestrator 中的指定队列。
清除数据表	清除指定数据表中的所有数据。
压缩 Zip 文件	将指定的文件或文件夹添加到压缩 (zip) 文件存档中。
复制文件	将文件从指定位置复制到另一位置。
创建文件	在指定位置创建空文件。如果该位置已存在文件，
创建文件夹	在指定位置中创建目录。
删除文件或文件夹	删除指定的文件或文件夹。
删除队列项目	使您能够从指定的 Orchestrator 队列中删除状态为“新” 的项目。
删除存储文件	将文件上传到 Orchestrator 中的指定存储桶。
下载存储文件	将 Orchestrator 存储桶中的文件副本下载到本地。
提取解压缩文件	“提取文件/解压缩文件”- 将 zip 文件存档的所有内容提取到指定文件夹。
筛选数据表	通过在“筛选器”微件中指定条件来筛选数据表。
获取资产	使用提供的资产名称获取指定的 Orchestrator资产。
获取凭据	使用提供的资产名称获取指定的凭据资产。
GetJobs	使用 Orchestrator API 根据自定义筛选器来检索 Orchestrator 作业的列表。
获取队列项目	该方法从队列中获取一个项目，以便您可以处理 (启动事务) 并将其状态设置为“正在进行”。
GetQueueItems	使您能够根据创建日期、优先级、状态和引用等多个筛选条件，从指定的 Orchestrator 队列中检索最多 100 个事务的列表。
获取本地路径的资源	从文件或文件夹的本地路径构建资源。
获取行项目	读取行项目 - 根据指定的列从数据表的行中检索值。
获取事务项目	从 Orchestrator 队列中获取一个项目，以便您可以处理 (启动事务) 并将其状态设置为 “正在进行”。
调用流程	执行本地机器可用的 UiPath 流程。
联接数据表	根据 `JoinType` 参数中指定的“联接”规则，使用彼此通用的值合并两个表中的行。
列出存储文件	列出 Orchestrator 中指定存储桶中与给定模式匹配的文件。
查找数据表	此方法模拟 VLOOKUP Excel 公式的行为。它使您能够在指定的“ `DataTable` ”中搜索提供的值，并返回找到该值的行索引。
合并数据表	将目标与源合并，指示是否保留更改以及如何处理源中缺少的架构。
移动文件	将文件从指定位置移动到另一位置。
Orchestrator HTTP 请求	对 Orchestrator API 执行 HTTP 请求，方法是在执行此应用程序编程接口的 Robot 下进行身份验证。
OutputDataTable	使用 CSV 格式将数据表写入字符串。
存在路径	检查指定的路径是否存在。路径可以表示文件路径或目录路径。
推迟事务项目	添加两个时间参数，Orchestrator 事务必须在这两个时间之间（不早于“延期日期”且不晚于“截止日期”）处理。
读取存储文本	从 Orchestrator 中的指定存储桶下载文件，并将其存储在字符串变量中。
读取文本文件	读取指定文件中的所有字符，并将其存储在字符串变量中。
删除数据列	从指定数据表中删除数据列。
删除重复行	从指定的“`DataTable`”变量中删除重复行，而仅保留第一次出现的行。
替换	在指定的输入字符串中，将正则表达式模式的匹配字符串替换为指定的替换字符串。
设置资产	用于更新指定资产的值，该资产已在 Orchestrator 中可用，无论是全局资产还是每个机器人资产。
设置凭据	用于更新指定凭据资产的值，该资产已在 Orchestrator 中可用，无论是全局资产还是一个机器人资产。
SetTransactionProgress	帮助您为正在进行的 Orchestrator 事务创建自定义进度状态。
设置事务状态	将 Orchestrator 事务项目的状态设置为“失败”或“成功”。
数据表排序	根据指定列的值，按升序或降序对整个“`DataTable`”进行排序。
开始作业	用于在 Orchestrator 上启动作业，并使其在指定数量的机器人上运行。
停止作业	用于停止或终止 Orchestrator 上的某个作业。
更新行项目	将指定值赋予数据表行的指定列。
上传存储文件	将文件上传到 Orchestrator 中的指定存储桶。
等待队列项目	从指定队列检索 Orchestrator 队列项目，并将其存储在 `QueueItem` 变量中。
写入存储文本	将字符串上传到 Orchestrator 中的指定存储桶。
写入文本文件	将指定文本写入文件。如果文件已经存在，则预先存在的文本将被覆盖。