跳到主要内容

获取流程表单场景

接口

HttpPost:api/FrontEnd/GetWorkflowScene

根据业务数据和流程实例获取当前工作项、节点名称、流程版本、待办状态及流程状态,供定制移动端决定表单应以待办、已办或暂存模式打开。

请求参数

请求头

参数名类型是否必填说明
Authorizationstring登录令牌,格式为 Bearer {token}
UserIdstring当前登录账号编码,必须与令牌用户一致。
TnCodestring租户编码。

请求体

参数名类型是否必填说明
userIdstring当前登录用户 ID 或账号编码。
formCodestring功能菜单或表单编码。
dataIdstring业务数据 ID。
flowIdstring流程实例 ID;已知时传入。
flowItemIdstring工作项 ID;已知时传入。
cardTypeinteger卡片类型;0 工作项,1 传阅项。

请求示例

POST /baseUrl/api/FrontEnd/GetWorkflowScene HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9...
UserId: administrator
TnCode: 00000000
Content-Type: application/json
{
"userId": "administrator",
"formCode": "purchase_apply",
"dataId": "205e4ed8-db1f-40c7-9e2d-bf656d53c2cd",
"flowId": "flow-001",
"cardType": 0
}

返回结果

响应使用平台统一包装。

参数名类型说明
Codeint200 表示成功。
Messagestring错误信息。
Resultobject流程场景。
Result.FlowIdstring流程实例 ID。
Result.WorkItemIdstring当前工作项 ID。
Result.WorkItemNamestring当前节点名称。
Result.WorkflowVersionint流程版本。
Result.IsUnfinishboolean是否为未完成待办。
Result.Stateint流程状态;0 暂存,2 已提交。
Result.ItemTypestring工作项或传阅项。
Statusint1 表示成功,3 表示业务错误。

返回示例

{
"Code": 200,
"Message": "",
"Result": {
"FlowId": "flow-001",
"WorkItemId": "workitem-001",
"WorkItemName": "部门负责人审批",
"WorkflowVersion": 3,
"IsUnfinish": true,
"State": 2,
"ItemType": "WorkItem"
},
"Status": 1,
"MessageShowType": null
}

调用说明

  • IsUnfinish=trueWorkItemId 有值时,通常按当前待办节点权限打开表单。
  • 已完成流程可能返回 IsUnfinish=false,移动端应按查看模式打开。
  • 用户无权访问菜单或业务数据不在数据范围内时请求失败。