GET 流程实例详情
GET 查询。query 参数:id(实例ID,必填)。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
workflow.instance.detail | workflow:read | GET /v1/workflow/instance/detail(comap-workflow) |
员工权限:本接口按权限码 workflow:records 对照绑定员工的主站功能权限。
请求参数(query)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 是 | 流程实例ID |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "workflow.instance.detail",
"query": {
"id": "1961000000000000001"
}
}'
响应 data 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | integer(int64) | — | 实例ID |
workflowId | integer(int64) | — | 流程定义ID |
workflowCode | string | — | 流程编码 |
workflowVersion | integer(int32) | — | 流程版本 |
isSystemWorkflow | integer(int32) | — | 是否系统流程 |
instanceNo | string | — | 实例编号 |
title | string | — | 流程标题 |
priority | integer(int32) | — | 优先级 |
businessKey | string | — | 业务主键 |
status | string | — | 流程状态 |
initiatorId | integer(int64) | — | 发起人ID |
initiatorName | string | — | 发起人姓名 |
initiatorAvatar | string | — | 发起人头像 |
currentNodeId | integer(int64) | — | 当前节点ID |
currentNodeName | string | — | 当前节点名称 |
workflowName | string | — | 流程名称 |
startTime | string(date-time) | — | 开始时间 |
formData | string | — | 表单数据(JSON字符串) |
workflowSnapshot | string | — | 流程快照 |
suspendTime | string(date-time) | — | 暂停时间 |
suspendReason | string | — | 暂停原因 |
endTime | string(date-time) | — | 结束时间 |
createTime | string(date-time) | — | 创建时间 |
updateTime | string(date-time) | — | 更新时间 |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 workflow:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-workflow 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回流程实例