函数 - 知行之桥文档

API 函数扩展了可对系统 API 资源执行的操作集。函数也可以执行与特定资源无关的操作。函数始终使用 HTTP POST 调用。每个函数都使用以下约定在专用的应用程序端点公开：/api.rsc/actionName。例如，如果托管在 mydomain.com 上并监听 8001 端口，则将使用以下端点来访问 cleanup 函数：

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

函数参数在 HTTP POST 的 JSON 格式正文中指定。请求必须包含适当的 content-type 头部（例如 application/json），以便正确解释 POST 正文。点击导航栏上的 API 可查看每个函数的可用参数。系统 API 包含以下函数：

函数	描述
cleanup	归档或删除日志文件、数据库中的事务条目，以及（可选）指定工作区和端口的 Send、Sent 和 Received 文件夹中的文件。
copyConnector	使用现有端口配置创建新的端口。
copyWorkspace	创建新的工作区，并复制现有工作区中的所有端口。
createCert	创建新的数字证书（公钥/私钥对），用于加密、签名、解密、验证、SSL/TLS 等。
exchangeCert	与交易伙伴交换指定证书的公钥。仅适用于 AS2 和 OFTP 端口。
export	根据个人设置、端口设置或工作区设置创建配置文件（`.arcflow`）。
exportDataEncryptionKey	将主加密密钥导出为加密数据块，其中包含数据加密密钥及其相关加密元数据。
getMessageCount	检索一个或多个工作区中所有端口未发送消息的数量。
getTransactionLogs	检索特定事务的详细事务日志数据。
import	从配置归档文件（`.arcflow`）将个人设置、端口设置或工作区设置导入到。
importDataEncryptionKey	将加密密钥（通常从生产环境导出）导入到开发或测试实例中，使开发环境能够解密来自生产备份或导入的配置数据和凭据。
receiveFile	指示特定端口触发端口的接收操作，以下载/接收特定文件（适用于 FTP、SFTP 和 S3 端口）或所有适用文件（基于端口配置）。
requeueMessage	将消息移回 Send 文件夹处理队列，以便重新处理。
sendFile	指示端口处理（上传、发送、转换等）该端口 Send 文件夹中的文件。
setFlow	为指定工作区设置流程连接。