Claim Task¶
Claim a task.
Request Format¶
POST https://{apigw-address}/enos-bpm-service/v2.0/work/tasks/claim
Request Parameters (Header)¶
Name |
Location |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|---|
Authorization |
Header |
Mandatory |
String |
The access token, which is represented by the bearer token. It can be obtained by invoking the Log In or Refresh Access Token API. |
Request Parameters (URI)¶
Name |
Location (Path/Query) |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|---|
taskId |
Query |
Mandatory |
String |
The task ID. |
Response Parameters¶
Name |
Data Type |
Description |
---|---|---|
data |
Data Struct |
Information about the claimed task. |
Data Struct¶
Name |
Data Type |
Description |
---|---|---|
taskStatus |
String |
The task status (inProgress, completed, unclaimed). |
Error Codes¶
Code |
Description |
---|---|
33403 |
The current user does not have the permission to claim this task. |
33404 |
The task ID does not exist. |
Samples¶
Request Sample¶
url: https://{apigw-address}/enos-bpm-service/v2.0/work/tasks/claim?taskId={your_task_id}
method: POST
headers: {"Authorization":"Bearer {your_access_token}"}
Return Sample¶
{
"code": 0,
"msg": "",
"data": {
"taskStatus": "inProgress"
}
}
Java SDK Sample¶
public class BpmSdkTest{
@Test
public void claimTaskTest() {
String bearerToken = "your_bearer_token";
String taskId = "task_id";
TaskClaimRequest request = new TaskClaimRequest(taskId, bearerToken);
TaskClaimResponse response = Poseidon.config(PConfig.init().appKey("your_access_key")
.appSecret("your_secret_key").debug()).url("https://{apigw-address}")
.getResponse(request, TaskClaimResponse.class);
assertNotNull("response cannot be null", response);
}
}