系统 API

Version 24.1.8896


系统 API

Version 24.1.8896


知行之桥内置的系统 API 提供了一种灵活的方式来管理应用程序。在管理控制台用户界面中可以完成的所有操作也可以通过调用 RESTful API 来完成。

系统 API 由一组 API 资源和一组 API 函数组成。可以组合调用这些资源和函数的 API,以从外部脚本,服务器和应用程序管理应用程序:

  • 检索应用程序工作流中的文件
  • 检索有关应用程序处理的文件的元数据或日志数据
  • 将文件插入应用程序工作流进行处理
  • 更新端口或文件配置
  • 触发端口的发送/接收功能

系统 API 支持将 JSON 格式的 OData 作为默认的 REST 协议。还支持其它 Web 服务格式包括 OData(Atom),SOAP,HTML 和 CSV。

API Browser

资源函数部分包含 API 中可用资源和函数的概述。可以在 API Browser 中找到有关每个资源和函数的更多信息。

要访问 API Browser, 请从应用程序用户界面的 API 菜单中选择 系统 API:

API Browser 包括每个资源和函数的可用属性,以及用于使用该 API 的代码示例(JQuery和cURL)。

注意,一些必填属性 “ID”,可以通过组合其它属性来操作。例如,如果文件是由 “ConnectorId”,“Folder” 和 “Filename” 的组合标识的,则不需要 Files Resource 的 “ MessageId” 属性来获取特定文件。类似地,如果事先未知,则可以省略日志资源(LogsTransactionsRequests)的 ID。