Get Process Instance¶
获取流程实例详情。
请求格式¶
GET https://{apigw-address}/enos-bpm-service/v2.0/work/process-instances
请求参数(Header)¶
名称 | 位置 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
Authorization | Header | 必需 | String | Access Token,以 Bearer Token 表示,需要通过调用 Log In 或 Refresh Access Token 接口后获取。 |
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
processInstanceId | Query | 必需 | String | 流程实例 ID。 |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
data | data 结构体 | 流程实例详情。 |
data 结构体¶
名称 | 数据类型 | 描述 |
---|---|---|
id | String | 流程实例 ID。 |
name | String | 流程名称。 |
businessKey | String | 流程实例的键。 |
processDefinitionId | String | 流程定义 ID。 |
processDefinitionName | String | 流程定义名称。 |
processDefinitionDescription | String | 流程定义描述。 |
processDefinitionKey | String | 流程定义的键。 |
processDefinitionCategory | String | 流程定义类型。 |
processDefinitionVersion | Integer | 流程定义版本号。 |
processDefinitionDeploymentId | String | 流程定义对应的部署资源 ID。 |
graphicalNotationDefined | Boolean | 是否定义流程图标。 |
startFormDefined | Boolean | 是否定义流程启动表单。 |
tenantId | String | 组织 ID。 |
createdTime | Timestamp | 流程实例创建时间。 |
completedTime | Timestamp | 流程实例结束时间。 |
terminable | Boolean | 当前用户是否可以终止当前流程。 |
terminatedTime | Timestamp | 流程实例终止时间。 |
terminateReason | String | 流程实例终止原因。 |
startedBy | UserRepresentation 结构体 | 流程发起人的信息。 |
terminatedBy | UserRepresentation 结构体 | 流程终止人的信息。 |
assignee | UserRepresentation 结构体 | 当前任务处理人的信息。 |
taskName | String | 当前任务名称。 |
url | String | 流程详情在 BPM 应用中的 URL。 |
UserRepresentation 结构体¶
名称 | 数据类型 | 描述 |
---|---|---|
id | String | 用户 ID。 |
firstName | String | 用户名字。 |
lastName | String | 用户姓氏。 |
String | 用户邮箱。 | |
fullName | String | 用户全名。 |
tenantId | String | 组织 ID。 |
groups | GroupRepresentation 结构体数组 | 用户组。 |
privileges | String 数组 | 用户权限。 |
GroupRepresentation 结构体¶
名称 | 数据类型 | 描述 |
---|---|---|
id | String | 用户组 ID。 |
name | String | 用户组名称。 |
type | String | 用户组类型。 |
错误码¶
代码 | 描述 |
---|---|
33404 | 流程实例 ID 不存在或没有查看权限。 |
示例¶
请求示例¶
url: https://{apigw-address}/enos-bpm-service/v2.0/work/process-instances?processInstanceId={your_process_instance_id}
method: GET
headers: {"Authorization":"Bearer {your_access_token}"}
返回示例¶
{
"code": 0,
"msg": "",
"data": {
"id": "2e0130f7-e39a-11ea-b667-e2b39eaec113",
"name": "0821终止",
"businessKey": "a2e00e2d6e39a11eab667e2b39eaec113",
"processDefinitionId": "5abd9f71-e365-11ea-8a6b-be43f0d99bcd",
"tenantId": "o15874765326651",
"started": 1598006192452,
"ended": null,
"startedBy": {
"id": "u15935734241501",
"firstName": null,
"lastName": null,
"email": "john.smith@univers.com",
"fullName": "john.smith",
"tenantId": "o15874765326651",
"groups": [],
"privileges": []
},
"processDefinitionName": "0821终止",
"processDefinitionDescription": null,
"processDefinitionKey": "ad970b963e35511ea8a6bbe43f0d99bcd",
"processDefinitionCategory": "http://flowable.org/test",
"processDefinitionVersion": 3,
"processDefinitionDeploymentId": "5a9be69e-e365-11ea-8a6b-be43f0d99bcd",
"graphicalNotationDefined": true,
"startFormDefined": true,
"assignee": null,
"taskName": null,
"url": null,
"terminable": false,
"terminatedBy": {
"id": "u15935734241501",
"firstName": null,
"lastName": null,
"email": "john.smith@univers.com",
"fullName": "john.smith",
"tenantId": "o15874765326651",
"groups": [],
"privileges": []
},
"terminateReason": "终止原因",
"variables": [],
"terminatedTime": 1598006269443,
"processInstanceId": "2e0130f7-e39a-11ea-b667-e2b39eaec113",
"completedTime": null,
"processName": "0821终止",
"createdTime": 1598006192452,
"processStatus": "terminated"
}
}
Java SDK 调用示例¶
public class BpmSdkTest{
@Test
public void getProcessInstanceTest() {
String bearerToken = "your_bearer_token";
String processInstanceId = "process_instance_id";
ProcessInstanceGetRequest request = new ProcessInstanceGetRequest(processInstanceId, bearerToken);
ProcessInstanceGetResponse response = Poseidon.config(PConfig.init().appKey("your_access_key")
.appSecret("your_secret_key").debug()).url("https://{apigw-address}")
.getResponse(request, ProcessInstanceGetResponse.class);
assertNotNull("response cannot be null", response);
}
}