BARTENDER REST API 使用说明
Available Actions in the Actions API |
BarTender REST API 提供 REST 终结点，这些终结点可用于以 YAML 或 JSON 格式或现有的旧版 BTXML 脚本运行各种操作。
BarTender REST API 中可用的操作与 BarTender Designer、Integration Builder 和 Process Builder 中可运行的操作基本相同。如果您喜欢使用图形用户界面来配置自动化，那么可以使用这些应用程序。但如果您想要以编程方式来运行操作，那么可以使用 REST API。
BarTender REST API 支持以下操作。
打印操作
操作 | 描述 |
|---|---|
PrintBTWAction | 打印 BarTender 文档。 |
PrintBTXMLScriptAction | 使用 BTXML 脚本打印一个或多个 BarTender 文档。 |
PrintCommandScriptAction | 使用命令行和数据的组合打印 BarTender 文档。 |
转换操作
操作 | 描述 |
|---|---|
BTXMLPrintResponseToIBMWebSphereAction | 将从上次运行的 BarTender 命令接收到的 BTXML 脚本响应转换为 IBM WebSphere Sensor Events。 |
IBMWebSphereToBTXMLAction | 将传入的 IBM WebSphere Sensor Events 转换为 BTXML 脚本。 |
IBMWebSphereToBTXMLWithPrintStatusAction | 将传入的 IBM WebSphere Sensor Events 转换为含有打印状态的 BTXML 脚本。 |
InsertAfterEndAction | 在内容末尾插入特定的文本或字符。 |
InsertBeforeStartAction | 在内容开头插入特定的文本或字符。 |
OraclePrintRequestToBTXMLAction | 将传入的 Oracle XML 请求转换为 BTXML 脚本。 |
SAPAIIToBTXMLAction | 将传入的 SAP AII XML 转换为 BTXML 脚本。 |
SearchAndDeleteAction | 在内容中搜索并删除特定的文本或字符。 |
SearchAndDeleteEverythingAfterAction | 在内容中搜索特定的文本或字符，并删除其后面的所有内容。 |
SearchAndDeleteEverythingAfterAction | 在内容中搜索特定的文本或字符，并删除其前面的所有内容。 |
SearchAndInsertAfterAction | 在内容中搜索特定的文本或字符，并将其插入到指定的文本后面。 |
SearchAndInsertBeforeAction | 在内容中搜索特定的文本或字符，并将其插入到指定的文本前面。 |
SearchAndReplaceAction | 在内容中搜索特定的文本或字符，并将其替换为指定的文本。 |
TransformXMLUsingXSLTAction | 使用 XSLT 样式表转换自定义或专有 XML 格式。 |
输入操作
操作 | 描述 |
|---|---|
ReadFileAction | 读取任何受支持文件系统上的文件内容，包括 FTP、Web 和云存储。 |
ReadFromNetworkSocketAction | 从 TCP 或 UDP 套接字读取传入的数据。 |
ReadFromSerialPortAction | 从串行端口读取以查找传入的数据。 |
WaitForFileAction | 等待文件出现在指定的文件夹中，然后再运行后续操作。 |
输出操作
操作 | 描述 |
|---|---|
SendEmailAction | 发送电子邮件。 |
SendToMessageQueueAction | 向 Microsoft 消息队列 (MSMQ) 服务发送消息。 |
SendToNetworkSocketAction | 通过 TCP 或 UDP 套接字发送数据。 |
SendToSerialPortAction | 将信息写入到串行端口。 |
SendWebServiceRequestAction | 向 Web 服务（REST 或 SOAP）发送 HTTP 请求。 |
WriteFileAction | 将内容写入到文件。 |
WriteMessageToLogAction | 将信息发送到消息日志。 |
执行操作
操作 | 描述 |
|---|---|
ActionGroup / GroupActions | 管理和运行一组操作。 |
BarTenderCommandLineAction | 使用命令行界面打印 BarTender 文档。 |
BarTenderProcessAction | 运行在 BarTender Process Builder 中创建的流程文件。 |
ConditionActions | 根据条件结果为 true 或 false 运行操作。 |
DecrementVariableAction | 每次运行操作时，以指定的值递减变量。 |
ForEachFileInArchiveActions | 针对归档文件夹中满足指定筛选条件的所有文件，运行一组操作（包含一个或多个操作）。 |
ForEachFileInFolderActions | 针对文件夹中满足指定筛选条件的所有文件，运行一组操作（包含一个或多个操作）。 |
ForLoopActions | 通过递增或递减变量，对指定的循环运行组中的操作。 |
GoToAction | 跳转到特定的操作以继续处理。 |
IncrementVariableAction | 以指定的值递增变量。 |
PowerShellCommandAction | 运行 Windows PowerShell 命令（脚本）。 |
PrintBTWAction | 打印 BarTender 文档。 |
PrintBTXMLScriptAction | 使用 BTXML 脚本打印一个或多个 BarTender 文档。 |
PrintCommandScriptAction | 使用命令行和数据的组合打印 BarTender 文档。 |
RunAsUserActions | 使用指定的凭据运行一组操作。 |
SelectCaseAction | 根据指定的条件评估要运行的 Case 子操作。 |
SetMultipleVariablesAction | 设置一个或多个变量的值。 |
SetVariableAction | 设置一个变量的值。 |
ShellCommandAction | 运行一个能被用于运行操作系统命令或第三方工具的 shell 命令。 |
StopAction | 停止当前集成中的所有操作。 |
WaitAction | 指定等待操作完成所经过的时间量。可使用此操作在按顺序执行的操作中创建暂停。 |
WaitForFileAction | 等待文件出现在指定的文件夹中，然后再运行后续操作。 |
WhileLoopActions | 只要满足条件，就继续运行组中的操作。 |
WorkflowTransitionAction | 使用指定的转换，将 Librarian 文件在其工作流程中从一种状态移动到另一种状态。 |
文件操作
操作 | 描述 |
|---|---|
AddFilesToArchiveAction | 将文件夹中的一个或多个文件添加到归档中。 |
CopyFileAction | 将一个或多个文件从一个位置复制到另一个位置。 |
CopyFolderAction | 将文件夹复制到另一个文件夹位置。 |
CreateFolderAction | 创建文件夹。 |
DeleteFileAction | 删除一个或多个文件。 |
DeleteFolderAction | 删除文件夹。 |
ExtractFilesFromArchiveAction | 将归档中的一个或多个文件提取到指定的文件夹中。 |
ForEachFileInArchiveActions | 针对归档文件夹中满足指定筛选条件的所有文件，运行一组操作（包含一个或多个操作）。 |
ForEachFileInFolderActions | 针对文件夹中满足指定筛选条件的所有文件，运行一组操作（包含一个或多个操作）。 |
MoveFileAction | 将一个或多个文件从一个位置移动到另一个位置。 |
MoveFolderAction | 将文件夹从一个位置移动到另一个位置。 |
ReadFileAction | 读取任何受支持文件系统上的文件内容，包括 FTP、Web 和云存储。 |
RenameFileAction | 重命名文件。 |
RenameFolderAction | 重命名文件夹。 |
WriteFileAction | 将内容写入到文件。 |
WorkflowTransitionAction | 使用指定的转换，将 Librarian 文件在其工作流程中从一种状态移动到另一种状态。 |
数据库操作
操作 | 描述 |
|---|---|
DeleteDatabaseRecordAction | 从相连数据库中删除一条或多条记录。 |
ExecuteSQLAction | 运行 SQL 脚本。 |
ForEachDatabaseRecordActions | 对数据库查询中的每条记录运行操作。 |
InsertDatabaseRecordAction | 将数据库记录插入到连接的数据库中。 |
TransformTextToRecordSetAction | 将文本或文本文件转换为记录集。 |
UpdateDatabaseRecordsAction | 更新一条或多条数据库记录。 |
| To help you automate these actions by using the YAML file format, a YAML actions reference is provided as follows:
|
