查询我的申请单草稿 - findDraftList
功能介绍
本接口用于分页查询当前用户保存的申请单草稿列表,适用于用户查看自己保存但未提交的流程草稿。
与启动流程实例 - startProcessInstance接口配合,可将草稿转为正式流程实例并启动流程;与获取流程模板列表 - findMaxTemplates接口配合,可选择合适的流程模板创建新草稿;与查询模板详情 - findBpmDesignQuery接口配合,可获取模板的完整设计信息用于填写草稿。
接口约束
本接口支持基础版和体验版数据建模引擎-流程引擎场景。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /services/workflow/findDraftList/{pageSize}/{curPage}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pageSize | 是 | String | 参数解释: 分页大小,指定每页返回的记录数量。需与“curPage”同时传入才生效。 约束限制: 建议取值范围1-100,过大可能影响接口性能。 取值范围: 正整数,取值范围1-100。 默认取值: 不涉及。 |
| curPage | 是 | String | 参数解释: 当前页码,用于指定分页查询的页数。需与“pageSize”同时传入才生效,从1开始计数。 约束限制: 不涉及。 取值范围: 正整数,取值范围1-1000。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| processDefinitionNameCn | 否 | String | 参数解释: 流程模板中文名称,用于按流程模板名称筛选草稿。支持模糊匹配。 约束限制: 不涉及。 取值范围: 最大长度4000字符。 默认取值: 不涉及。 |
| title | 否 | String | 参数解释: 草稿名称,用于按流程实例标题筛选草稿。支持模糊匹配。 约束限制: 不涉及。 取值范围: 最大长度4000字符。 默认取值: 不涉及。 |
| createStartTime | 否 | String | 参数解释: 创建时间起始点,用于按草稿创建时间范围筛选。建议格式为yyyy-MM-dd HH:mm:ss。 约束限制: 不涉及。 取值范围: 最大长度100字符。 默认取值: 不涉及。 |
| createEndTime | 否 | String | 参数解释: 创建时间结束点,用于按草稿创建时间范围筛选。建议格式为yyyy-MM-dd HH:mm:ss。 约束限制: 不涉及。 取值范围: 最大长度100字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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 | Array of data objects | 参数解释: 接口响应数据,包含当前页的草稿列表。每个元素为一个申请单草稿的详细信息,包括草稿ID、流程模板信息、业务流水号、状态、创建时间等。 取值范围: 不涉及。 |
| pageInfo | PageVo object | 参数解释: 标准响应体分页信息,包含总记录数、当前页、页大小、总页数等。 取值范围: 不涉及。 |
| orderID | String | 参数解释: 请求跟踪流水号,用于唯一标识本次接口请求,便于问题排查和链路追踪。 遇到问题时,请提供此ID联系技术支持。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| lastUpdateDate | Integer | 参数解释: 最后更新时间,标识草稿最近一次修改的时间。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| modifier | String | 参数解释: 修改人UUID,标识最后修改该草稿的用户ID。 取值范围: 不涉及。 |
| processTemplateName | String | 参数解释: 流程模板名,标识该草稿使用的流程模板英文名称。 取值范围: 不涉及。 |
| templateId | String | 参数解释: 流程模板编号,与processTemplateName一致,用于唯一标识流程模板定义。 取值范围: 不涉及。 |
| productLine | String | 参数解释: 产品线,标识草稿所属的产品线信息。 取值范围: 不涉及。 |
| currentUserUuid | Integer | 参数解释: 当前用户UUID,标识当前操作用户的UUID。 取值范围: 不涉及。 |
| bizCategory | String | 参数解释: 业务类型,标识草稿的业务分类。 取值范围: 不涉及。 |
| bizSeqExtAttrs | Array of strings | 参数解释: 业务对象拓展属性集合,包含草稿的扩展业务属性列表。 取值范围: 不涉及。 |
| lastUpdateUserCN | String | 参数解释: 最后更新人,用于展示最后修改人的可读名称。 取值范围: 不涉及。 |
| processTitle | String | 参数解释: 流程实例名称,通常为流程模板名称与创建时间的组合,用于展示。 取值范围: 不涉及。 |
| bizSeqExtType | String | 参数解释: 业务对象拓展类型名称,标识草稿的业务对象扩展类型。 取值范围: 不涉及。 |
| id | String | 参数解释: ID,用于唯一标识一个申请单草稿。可通过此ID调用删除草稿或启动流程接口。 取值范围: 不涉及。 |
| state | String | 参数解释: 状态,标识当前草稿的生命周期状态。 取值范围: |
| lastUpdatedBy | String | 参数解释: 最后更新人ID,与modifier字段一致,标识最后修改该草稿的用户ID。 取值范围: 不涉及。 |
| processInstanceId | String | 参数解释: 流程实例ID,标识该草稿对应的流程实例。为null表示草稿尚未转为正式流程实例。 取值范围: 不涉及。 |
| entityType | String | 参数解释: 模型分类,标识草稿的业务实体类型。通常为business表示业务对象。 取值范围: 不涉及。 |
| holdableList | Array of strings | 参数解释: 表单集,标识草稿包含的表单数据类型列表。如WfFormData(表单数据)、WfAttachment(附件)、WfBusinessObject(业务对象)等。 取值范围: 不涉及。 |
| finished | Boolean | 参数解释: 是否结束,标识该草稿对应的流程是否已结束。 取值范围: |
| creationDate | Integer | 参数解释: 创建日期,标识草稿的首次创建时间。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| ccByUuid | String | 参数解释: 抄送人UUID,标识草稿的抄送人ID。如需添加多个抄送人,请使用英文逗号(,)隔开。 取值范围: 不涉及。 |
| processTemplateNameCn | String | 参数解释: 流程模板中文名,标识该草稿使用的流程模板中文名称,用于展示。 取值范围: 不涉及。 |
| reserve10 | String | 参数解释: 预留字段10,用于扩展业务属性。 取值范围: 不涉及。 |
| scope | String | 参数解释: 类型码,标识草稿的作用范围或类型编码。 取值范围: 不涉及。 |
| lifeCycleState | String | 参数解释: 生命周期状态,标识草稿的详细生命周期阶段。 取值范围: 不涉及。 |
| creationUserCN | String | 参数解释: 创建者中文名称,用于展示创建人的可读名称。 取值范围: 不涉及。 |
| creator | String | 参数解释: 创建人UUID,标识创建该草稿的用户ID。 取值范围: 不涉及。 |
| product | String | 参数解释: 产品,标识草稿所属的产品信息。 取值范围: 不涉及。 |
| appName | String | 参数解释: 应用名称,标识该草稿所属的应用系统。与请求Header中的X-Application-Id对应。 取值范围: 不涉及。 |
| processTemplateVersion | String | 参数解释: 流程模板版本,标识该草稿使用的流程模板版本号。 取值范围: 不涉及。 |
| subItem | String | 参数解释: 子项,标识草稿的子项目或子分类信息。 取值范围: 不涉及。 |
| reserve1 | String | 参数解释: 预留字段1,用于扩展业务属性。 取值范围: 不涉及。 |
| reserve2 | String | 参数解释: 预留字段2,用于扩展业务属性。 取值范围: 不涉及。 |
| reserve3 | String | 参数解释: 预留字段3,用于扩展业务属性。 取值范围: 不涉及。 |
| reserve4 | String | 参数解释: 预留字段4,用于扩展业务属性。 取值范围: 不涉及。 |
| reserve5 | String | 参数解释: 预留字段5,用于扩展业务属性。 取值范围: 不涉及。 |
| reserve6 | String | 参数解释: 预留字段6,用于扩展业务属性。 取值范围: 不涉及。 |
| reserve7 | String | 参数解释: 预留字段7,用于扩展业务属性。 取值范围: 不涉及。 |
| reserve8 | String | 参数解释: 预留字段8,用于扩展业务属性。 取值范围: 不涉及。 |
| reserve9 | String | 参数解释: 预留字段9,用于扩展业务属性。 取值范围: 不涉及。 |
| creationUserUuid | String | 参数解释: 创建人UUID,与creator字段一致,标识创建该草稿的用户ID。 取值范围: 不涉及。 |
| createdBy | String | 参数解释: 创建人,标识创建该草稿的用户账号。 取值范围: 不涉及。 |
| businessKey | String | 参数解释: 业务流水号,即申请单Key,由业务系统生成。草稿保存时生成,启动流程后保持不变。 取值范围: 不涉及。 |
| ccBy | String | 参数解释: 抄送人短工号,标识草稿的抄送人。如需添加多个抄送人短工号,请使用英文逗号(,)隔开。 取值范围: 不涉及。 |
| comment | String | 参数解释: 备注,包含草稿的附加说明或备注信息。 取值范围: 不涉及。 |
| productTeam | String | 参数解释: 产品团队,标识草稿所属的产品团队信息。 取值范围: 不涉及。 |
| lifeCycleStateKey | String | 参数解释: 生命周期状态对应的Key,标识生命周期状态的编码值。 取值范围: 不涉及。 |
| parentBusinessKey | String | 参数解释: 父业务流水号,标识当前草稿的父级业务流水号。用于主子流程场景。 取值范围: 不涉及。 |
| taskId | String | 参数解释: 当前任务ID,标识草稿关联的当前任务。为null表示草稿尚未生成任务。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| totalRows | Integer | 参数解释: 数据总数,标识符合条件的流程实例总记录数。 取值范围: 非负整数。 |
| curPage | Integer | 参数解释: 当前页码,与请求参数中的curPage一致。 取值范围: 正整数。 |
| pageSize | Integer | 参数解释: 页大小,与请求参数中的pageSize一致。 取值范围: 正整数。 |
| totalPages | Integer | 参数解释: 总页数,根据totalRows和pageSize计算得出的总页数。计算公式为ceil(totalRows / pageSize)。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| result | String | 结果。 |
| trace_id | String | 追踪ID。 |
请求示例
GET https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/services/workflow/findDraftList/20/1
响应示例
状态码:200
OK
{
"msg" : null,
"code" : 0,
"data" : [ {
"lastUpdateDate" : 1710851310295,
"modifier" : "1008600000065234815",
"processTemplateName" : "ProcessSyyy240122_01",
"templateId" : "ProcessSyyy240122_01",
"productLine" : null,
"currentUserUuid" : "1008600000065234815",
"bizCategory" : null,
"bizSeqExtAttrs" : [ ],
"lastUpdateUserCN" : null,
"processTitle" : "ProcessSyyy240122_01_2024-03-19T20:28:29.303+0800",
"bizSeqExtType" : "WfBusinessSeq",
"id" : "611656531317895168",
"state" : "DRAFT",
"lastUpdatedBy" : "1008600000065234815",
"processInstanceId" : null,
"entityType" : "business",
"holdableList" : [ "com.huawei.it.plm.workflow.framework.model.WfFormData", "com.huawei.it.plm.workflow.framework.model.WfAttachment", "com.huawei.it.plm.workflow.framework.model.WfBusinessObject" ],
"finished" : false,
"creationDate" : 1710851081514,
"ccByUuid" : null,
"processTemplateNameCn" : "流程实例表格表单NULL校验",
"reserve10" : null,
"scope" : null,
"lifeCycleState" : null,
"reserve9" : null,
"creationUserCN" : "",
"reserve8" : null,
"creator" : "1008600000065234815",
"product" : null,
"reserve5" : null,
"reserve4" : null,
"appName" : "WfWorkflowDemoService",
"processTemplateVersion" : "7",
"reserve7" : null,
"reserve6" : null,
"reserve1" : null,
"subItem" : null,
"reserve3" : null,
"reserve2" : null,
"creationUserUuid" : "1008600000065234815",
"createdBy" : "1008600000065234815",
"businessKey" : "P10011128",
"ccBy" : null,
"comment" : null,
"productTeam" : null,
"lifeCycleStateKey" : null,
"parentBusinessKey" : null,
"taskId" : null
}, {
"lastUpdateDate" : 1710834762166,
"modifier" : "1008600000065234815",
"processTemplateName" : "Test_xdl_0220",
"templateId" : "Test_xdl_0220",
"productLine" : null,
"currentUserUuid" : "1008600000065234815",
"bizCategory" : null,
"bizSeqExtAttrs" : [ ],
"lastUpdateUserCN" : null,
"processTitle" : "Test_xdl_0220_2024-03-19T15:52:42.114+0800",
"bizSeqExtType" : "WfBusinessSeq",
"id" : "601704798319812608",
"state" : "DRAFT",
"lastUpdatedBy" : "1008600000065234815",
"processInstanceId" : null,
"entityType" : "business",
"holdableList" : [ "com.huawei.it.plm.workflow.framework.model.WfFormData", "com.huawei.it.plm.workflow.framework.model.WfAttachment", "com.huawei.it.plm.workflow.framework.model.WfBusinessObject" ],
"finished" : false,
"creationDate" : 1708478403070,
"ccByUuid" : null,
"processTemplateNameCn" : "Test_xdl_0220",
"reserve10" : null,
"scope" : null,
"lifeCycleState" : null,
"reserve9" : null,
"creationUserCN" : "",
"reserve8" : null,
"creator" : "1008600000065234815",
"product" : null,
"reserve5" : null,
"reserve4" : null,
"appName" : "WfWorkflowDemoService",
"processTemplateVersion" : "1",
"reserve7" : null,
"reserve6" : null,
"reserve1" : null,
"subItem" : null,
"reserve3" : null,
"reserve2" : null,
"creationUserUuid" : "1008600000065234815",
"createdBy" : "1008600000065234815",
"businessKey" : "P10010662",
"ccBy" : null,
"comment" : null,
"productTeam" : null,
"lifeCycleStateKey" : null,
"parentBusinessKey" : null,
"taskId" : null
} ],
"pageInfo" : {
"totalRows" : 29,
"curPage" : 1,
"pageSize" : 2,
"totalPages" : 15
},
"orderID" : "a6903f8109d547faaff11134dd872585"
} 状态码:400
Bad Request
{
"error_code" : "500",
"error_msg" : "origin is not allowed!",
"result" : "FAIL",
"trace_id" : "2509bee60b3e40asdf9f741d9e23466a9"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
错误码
请参见错误码。