资源 - 知行之桥文档

概览

资源是在系统 API 中公开的对象，可以查询、创建、更新和删除。这些资源包括：

资源	描述
Certificates	检索、创建、更新或删除用于加密、签名、解密、验证、SSL/TLS 等的数字证书。
Connectors	检索、更新或删除现有端口的配置，或向应用程序工作流添加新的端口。
Files	检索、更新或删除应用程序工作流中的文件，或通过将文件添加到端口的输入文件夹来将文件推送到应用程序工作流中。
FlowAPIs	从工作区检索 Flow API。
Logs	从应用程序日志中检索或删除日志数据，应用程序级错误记录在此日志中。
Profile	检索或更新应用程序本地配置文件的配置。
Reports	检索、创建、更新或删除应用程序中的报表。
Requests	从访问日志中检索或删除日志数据，HTTP 请求记录在此日志中。
Transactions	从事务日志中检索或删除元数据，成功和失败的文件传输（发送和接收）记录在此日志中。
Vault	检索、创建、修改或删除配置库项目。
Workspaces	检索、创建、修改或删除用于将端口组合在一起的工作区。

每个资源都使用以下约定在专用的应用程序端点公开：/api.rsc/resourceName。例如，如果托管在 mydomain.com 上并监听 8001 端口，则将使用以下端点来访问 Files 资源：

http://mydomain.com:8001/api.rsc/files

资源访问方法

本节介绍用于对系统 API 公开的资源执行操作的 HTTP 方法。

建议在发送数据时使用 JSON 或 x-www-form-urlencoded 负载进行 API 调用，尤其是在请求正文较大的调用中。

GET

HTTP GET 请求可用于从检索资源或资源集。GET 请求可以返回多项，也可以仅返回一项，具体取决于请求中是否指定了查询参数。

不带参数的 GET 请求

不包含查询参数的 GET 请求将返回该资源类型的所有实例。例如，如果对 Certificates 资源发出了不带查询参数的 GET 请求，则响应将包括应用程序中保存的每个证书。对 Connectors 资源的类似请求将返回流程中每个已配置端口实例的配置数据。不带参数的 GET 请求的目标 URL 应与资源端点相同。例如：

GET http://mydomain.com:8001/api.rsc/certificates

带参数的 GET 请求

GET 请求可以在目标 URL 中包含查询参数，以将结果集限制为目标资源的单个实例。例如，对 Files 资源的 GET 请求可以包含特定的端口、Folder 和 Filename 参数，以检索由该端口处理的单个文件。查询参数在目标 URL 末尾的括号中指定。例如：

GET http://mydomain.com:8001/api.rsc/files(connectorId='myConnector',Folder='Receive',Filename='myFile.txt')?@authtoken=myAuthTokenValue

应用程序 UI 中的 API 浏览器详细介绍了每种资源的可用参数。

POST

HTTP POST 请求可用于在中创建指定资源的新实例。例如，向 Files 资源发出 POST 请求会将文件插入到流程中，向 Connectors 资源发出 POST 请求会在流程中创建新的已配置端口。新资源的参数以 JSON 格式作为 POST 正文提供。该请求必须包含适当的 content-type 头部（例如 application/json），以便正确解释 POST 正文。应用程序 UI 中的 API 浏览器详细介绍了每种资源的可用属性。以下是 Connectors 资源的示例 POST 正文：

{
	"ConnectorId":"myNewConnector",
	"ConnectorType":"Zip",
	"Workspace":"Default",
}

Connectors 资源还根据指定的 ConnectorType 支持其他属性。通过在 JSON 正文中包含字段名称和值，可以在 POST 调用期间设置任何可配置的端口字段。例如，创建新的 Zip 端口时，可以将该端口的 Operation 字段设置为 Decompress：

{
	"ConnectorId":"myNewConnector",
	"ConnectorType":"Zip",
	"Workspace":"Default",
	"Operation":"Decompress"
}

POST 请求的目标 URL 应与资源端点相同：

POST http://mydomain.com:8001/api.rsc/connectors

PUT

HTTP PUT 请求可用于更新中指定资源的实例。例如，向 Connectors 资源发出 PUT 请求将更新流程中单个已配置端口的设置。 PUT 请求需要组合以下项目：

目标 URL 中的查询参数。这些参数指定要更新资源的哪个实例，例如要更新哪个端口。
PUT 请求 JSON 正文中的属性。这些属性决定该资源中要更新哪些字段，例如应将哪些端口配置字段设置为新值。

查询参数在目标 URL 末尾的括号中指定，例如：

PUT http://mydomain.com:8001/api.rsc/connectors(ConnectorId='myZipConnector')

请求的 JSON 正文包括要为目标资源实例更新的资源特定字段。该请求必须包含适当的 content-type 头部（例如 application/json），才能正确解释 PUT 正文。以下是用于更新 Zip 端口实例的 Operation 字段的 PUT 请求 JSON 正文示例：

{
 "Operation":"Compress"
}

DELETE

HTTP DELETE 请求可用于从中删除指定资源的实例。例如，对 Files 资源发出 DELETE 请求将从工作流中删除一个文件。 DELETE 请求在目标 URL 中包含查询参数，以标识要删除的资源实例。查询参数在目标 URL 末尾的括号中指定。例如：

DELETE http://mydomain.com:8001/api.rsc/files(connectorId='myConnector',Folder='Send',Filename='myfile.txt')

应用程序 UI 中的 API 浏览器详细介绍了每种资源的可用参数。

​概览

​资源访问方法

​GET

​不带参数的 GET 请求

​带参数的 GET 请求

​POST

​PUT

​DELETE

概览

资源访问方法

GET

不带参数的 GET 请求

带参数的 GET 请求

POST

PUT

DELETE