获取流程模板列表 - findMaxTemplates
功能介绍
本接口用于分页获取流程模板列表,适用于查询当前应用下所有流程模板的配置概览信息。
与查询模板详情 - findBpmDesignQuery接口配合,可获取某个模板的完整设计信息;与启动流程 - startProcessInstance接口配合,可根据查询到的模板ID启动新流程实例。
接口约束
本接口支持基础版和体验版数据建模引擎-流程引擎场景。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /services/workflow/navtree/processConfig/findMaxTemplates/{pageSize}/{curPage}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pageSize | 是 | String | 参数解释: 分页大小,指定每页返回的记录数量。需与“curPage”同时传入才生效。 约束限制: 建议取值范围1-100,过大可能影响接口性能。 取值范围: 正整数,取值范围1-100。 默认取值: 不涉及。 |
| curPage | 是 | String | 参数解释: 当前页码,用于指定分页查询的页数。需与“pageSize”同时传入才生效,从1开始计数。 约束限制: 不涉及。 取值范围: 正整数,取值范围1-1000。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 通过调用IAM服务获取用户Token接口获取(即响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Application-Id | 是 | String | 参数解释: 应用ID。 您可以在应用设计态的“应用中心 > 应用发布”页面获取,详情请参见应用发布。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| X-Tenant-Id | 是 | String | 参数解释: 数据建模引擎运行态租户ID。 您可以从访问流程引擎编排服务的浏览器地址栏中获取。 流程编排服务地址:http://{承载流程编排服务的服务器域名或IP地址}:{流程编排服务的端口号}/{流程编排服务文根}/index.html#/processApplicationForm?tenantId={数据建模引擎运行态租户ID}&applicationId={应用ID} 例如tenantId=-1,表示数据建模引擎运行态默认租户“basicTenant”的租户ID为-1。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-User-Id | 是 | String | 参数解释: 请求当前接口时上下文中的用户ID,即OrgID的用户ID。 通过调用OrgID服务的获取用户信息接口获取。 约束限制: 仅基础版数据建模引擎-流程引擎需要配置此参数。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| msg | String | 参数解释: 接口响应信息,描述接口调用的结果说明。当code非200时,此字段包含具体的错误描述。 取值范围: 不涉及。 |
| code | Integer | 参数解释: 接口返回码,标识接口调用的执行结果。 取值范围:
|
| data | data object | 参数解释: 接口响应数据,包含分页信息和流程模板列表。 取值范围: 不涉及。 |
| orderID | String | 参数解释: 请求跟踪流水号,用于唯一标识本次接口请求,便于问题排查和链路追踪。 遇到问题时,请提供此ID联系技术支持。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| pageVO | pageVO object | 参数解释: 分页信息对象,包含总记录数、当前页、页大小等分页相关数据。 取值范围: 不涉及。 |
| result | Array of result objects | 参数解释: 流程模板列表,包含当前页的所有流程模板配置信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| totalRows | Integer | 参数解释: 数据总数,标识符合条件的流程模板总记录数。 取值范围: 不涉及。 |
| curPage | Integer | 参数解释: 当前页码,与请求参数中的curPage一致。 取值范围: 不涉及。 |
| pageSize | Integer | 参数解释: 页大小,与请求参数中的pageSize一致。 取值范围: 不涉及。 |
| startIndex | Integer | 参数解释: 开始序号,标识当前页第一条记录在总记录中的序号(从1开始)。 取值范围: 不涉及。 |
| endIndex | Integer | 参数解释: 结束序号,标识当前页最后一条记录在总记录中的序号。 取值范围: 不涉及。 |
| orderBy | String | 参数解释: 排序字段,标识当前查询的排序方式。 取值范围: 不涉及。 |
| totalPages | Integer | 参数解释: 总页数,根据totalRows和pageSize计算得出的总页数。计算公式为ceil(totalRows / pageSize)。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| rejectDecisionLogic | String | 参数解释: 驳回处理逻辑,标识流程被驳回时的处理策略。 取值范围: 不涉及。 |
| enableAutoRefreshForm | Integer | 参数解释: 表单内容区自动刷新开关,标识表单是否自动刷新。 取值范围: 不涉及。 |
| lastUpdatedBy | String | 参数解释: 最后更新人userID,标识最后修改该模板的用户ID。 取值范围: 不涉及。 |
| endNodeValueSource | String | 参数解释: 结束节点取值来源,标识结束节点的数据来源配置。 取值范围: 不涉及。 |
| lastUpdateDate | Integer | 参数解释: 最后更新时间,标识模板最近一次修改的时间。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| isResetStatus | Integer | 参数解释: 重新提交是否重置已完成的状态,标识流程重新提交时是否重置节点状态。 取值范围: |
| creationUserAccount | String | 参数解释: 创建人账号,标识创建该模板的用户登录账号。 取值范围: 不涉及。 |
| showStartCarbonCopy | Integer | 参数解释: 启动流程是否抄送,标识流程启动时是否触发抄送。 取值范围: |
| lastUpdateUserAccount | String | 参数解释: 更新人短工号,标识最后修改该模板的用户短工号。 取值范围: 不涉及。 |
| includeEndNode | String | 参数解释: 包含结束节点,标识导航树是否包含结束节点。 取值范围: 不涉及。 |
| templateId | String | 参数解释: 流程模板ID,用于唯一标识流程模板定义。与流程元模板中的模板Key一致,可用于启动流程实例。 取值范围: 不涉及。 |
| creationDate | Integer | 参数解释: 创建时间,标识模板的首次创建时间。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| displayMode | String | 参数解释: 导航树展示方式,标识流程导航树的布局方向。 取值范围: |
| templateStatus | String | 参数解释: 流程模板状态,标识当前模板的发布状态。 取值范围: |
| createdBy | String | 参数解释: 创建人userID,标识创建该模板的用户ID。 取值范围: 不涉及。 |
| templateName | String | 参数解释: 流程模板名称,用于展示流程模板的标题。与流程设计态中配置的模板名称一致。 取值范围: 不涉及。 |
| showTips | Integer | 参数解释: 是否展示Tips提示,标识流程页面是否显示提示信息。 取值范围: |
| showTodoTaskNum | Integer | 参数解释: 是否展示任务数量,标识导航树是否显示待办任务数量。 取值范围: 不涉及。 |
| templateVersion | String | 参数解释: 流程模板版本,标识当前模板的版本号。 取值范围: 不涉及。 |
| id | Integer | 参数解释: 流程模板配置表ID,用于唯一标识流程模板配置记录。 取值范围: 不涉及。 |
| navJson | String | 参数解释: 流程模板导航节点JSON,包含流程模板的导航树配置信息,为JSON格式字符串。可用于前端渲染流程导航结构。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| result | String | 结果。 |
| trace_id | String | 追踪ID。 |
请求示例
GET https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/services/workflow/navtree/processConfig/findMaxTemplates/20/1
响应示例
状态码:200
OK
{
"msg" : null,
"code" : 0,
"data" : {
"pageVO" : {
"totalRows" : 118,
"curPage" : 1,
"pageSize" : 2,
"resultMode" : 0,
"startIndex" : 1,
"endIndex" : 2,
"orderBy" : null,
"filterStr" : null,
"totalPages" : 59
},
"result" : [ {
"rejectDecisionLogic" : null,
"enableAutoRefreshForm" : 0,
"lastUpdatedBy" : "1008600000065234815",
"endNodeValueSource" : null,
"lastUpdateDate" : 1709728194000,
"isResetStatus" : 0,
"creationUserAccount" : "hid_fje4j2nvnue3xwp",
"reserve1" : null,
"showStartCarbonCopy" : 0,
"lastUpdateUserAccount" : "hid_fje4j2nvnue3xwp",
"reserve3" : null,
"includeEndNode" : null,
"reserve2" : null,
"templateId" : "Test_xdl_0306",
"creationDate" : 1709728171000,
"displayMode" : "vertical",
"templateStatus" : "STARTED",
"createdBy" : "1008600000065234815",
"templateName" : "Test_xdl_0306",
"showTips" : 0,
"showTodoTaskNum" : 0,
"templateVersion" : "1",
"id" : 1000,
"navJson" : "{}"
}, {
"rejectDecisionLogic" : null,
"enableAutoRefreshForm" : 0,
"lastUpdatedBy" : "1008600000042328283",
"endNodeValueSource" : null,
"lastUpdateDate" : 1709708565000,
"isResetStatus" : 0,
"creationUserAccount" : "jixiang",
"reserve1" : null,
"showStartCarbonCopy" : 0,
"lastUpdateUserAccount" : "jixiang",
"reserve3" : null,
"includeEndNode" : null,
"reserve2" : null,
"templateId" : "EC_Process_passthrough_new_0306",
"creationDate" : 1709707629000,
"displayMode" : "vertical",
"templateStatus" : "STARTED",
"createdBy" : "1008600000042328283",
"templateName" : "EC流程_新_0306",
"showTips" : 0,
"showTodoTaskNum" : 0,
"templateVersion" : "2",
"id" : 2035,
"navJson" : "{}"
} ]
},
"orderID" : "943051cd64bf472f8221b445f28a1f2f"
} 状态码:400
Bad Request
{
"error_code" : "500",
"error_msg" : "origin is not allowed!",
"result" : "FAIL",
"trace_id" : "2509bee60b3e40asdf9f741d9e23466a9"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
错误码
请参见错误码。