21.3. 支持的 KIE Server REST API 端点
KIE Server REST API 为 Red Hat Process Automation Manager 中的以下资源类型提供端点:
- KIE 服务器和 KIE 容器
- KIE 会话资产(用于运行时命令)
- DMN 资产
- 规划程序
- Process
- 进程镜像
- 进程和任务表单
- 任务
- 问题单
- 文档
- Jobs
- 查询进程、任务和问题单
- 自定义查询
KIE Server REST API 基本 URL 是 http://SERVER:PORT/kie-server/services/rest/
。所有请求都需要对 kie-server
用户角色进行 HTTP 基本身份验证或基于令牌的身份验证。
有关 KIE Server REST API 端点和描述的完整列表,请使用以下资源之一:
- 在 jBPM 文档页面的 Execution Server REST API(静态)
http://SERVER:PORT/kie-server/docs
(动态,需要运行 KIE Server REST)的 KIE Server REST API 的 Swagger UI注意默认情况下,KIE 服务器的 Swagger Web 界面由
org.kie.swagger.server.ext.disabled=false
系统属性启用。要在 KIE 服务器中禁用 Swagger Web 界面,请将此系统属性设置为true
。
端点要求
请注意,以下对 KIE Server REST API 端点的要求:
-
Process images: 为了对处理镜像的 API 访问,必须为
$SERVER_HOME/standalone/deployments
/>。默认情况下,此属性设置为/business-central.war/org.kie.workbench.KIEWebapp/profiles/jbpm.xml
项目配置系统属性 <storesvgonsave enabled="true"true
。如果 API 没有使用进程镜像,在文件中将其设置为true
,重启您的 KIE 服务器,修改相关进程并保存它,然后构建和部署项目。此属性允许存储 SVG 镜像,以便由 KIE Server REST API 检索它们。 自定义查询: 一些带有 KIE Server REST API 的自定义查询请求需要查询
映射器
定义来将查询结果映射到协调对象。您可以实施自己的查询结果映射程序,或使用 Red Hat Process Automation Manager 提供的映射程序。Red Hat Process Automation Manager 中的查询映射器与其他对象关系映射(ORM)供应商类似,后者将表映射到实体。例如,您可以在自定义查询端点中使用org.jbpm.kie.services.impl.query.mapper.ProcessInstanceQueryMapper
,也可注册为ProcessInstances
,以返回进程实例数据。带有
ProcessInstances
mapper 参数的 POST 端点示例:http://localhost:8080/kie-server/services/rest/server/queries/definitions/jbpmProcessInstances?mapper=ProcessInstances
http://localhost:8080/kie-server/services/rest/server/queries/definitions/jbpmProcessInstances?mapper=ProcessInstances
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 如需 Red Hat Process Automation Manager 中可用的查询映射器列表,请从红帽客户门户网站下载并提取 Red Hat Process Automation Manager 7.9 Source Distribution,并进入
~/jbpm-$VERSION/jbpm-services/jbpm-kie-services/src/main/java/org/jbpm/kie/services/impl/query/mapper
。https://access.redhat.com/jbossnetwork/restricted/listSoftware.html