跳到主要内容

GET 流程实例详情

GET 查询。query 参数:id(实例ID,必填)。

接口编码所需范围后端接口
workflow.instance.detailworkflow:readGET /v1/workflow/instance/detail(comap-workflow)

员工权限:本接口按权限码 workflow:records 对照绑定员工的主站功能权限。

请求参数(query)

字段类型必填说明
idstring是流程实例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 字段

字段类型必填说明
idinteger(int64)—实例ID
workflowIdinteger(int64)—流程定义ID
workflowCodestring—流程编码
workflowVersioninteger(int32)—流程版本
isSystemWorkflowinteger(int32)—是否系统流程
instanceNostring—实例编号
titlestring—流程标题
priorityinteger(int32)—优先级
businessKeystring—业务主键
statusstring—流程状态
initiatorIdinteger(int64)—发起人ID
initiatorNamestring—发起人姓名
initiatorAvatarstring—发起人头像
currentNodeIdinteger(int64)—当前节点ID
currentNodeNamestring—当前节点名称
workflowNamestring—流程名称
startTimestring(date-time)—开始时间
formDatastring—表单数据(JSON字符串)
workflowSnapshotstring—流程快照
suspendTimestring(date-time)—暂停时间
suspendReasonstring—暂停原因
endTimestring(date-time)—结束时间
createTimestring(date-time)—创建时间
updateTimestring(date-time)—更新时间

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 workflow:read否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败是
92301请求过于频繁是

除此之外,comap-workflow 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回流程实例