You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 8
Next »
Assignment API can perform functions to interact or exchange data about task assignments.
| Name | Description |
|---|
| 1 | Complete assignment by username |
Complete an assignment via a username, to continue the flow of a process instance.
Name | Description |
|---|
| URL | /assignment/completeByUser/{username}/{activityId} | | HTTP Method | POST | | Path Parameters | | Parameter | Description |
|---|
| username | Username of a Joget user. | | activityId | Activity instance ID that is assigned to the specified user. |
| | Query String Parameters | | Parameter | Description |
|---|
| variables | Workflow variable value(s) to set. Can be multiple query parameters for many workflow variables. |
| | Sample Response |
{
"activityId": "381_150_expenseclaim_process1_new_claim",
"processId": "150_expenseclaim_process1",
"nextActivityId": "..."
}
|
|
| 2 | Complete assignment of current user |
Complete an assignment of the currently logged in user, to continue the flow of a process instance.
Name | Description |
|---|
| URL | /assignment/complete/{activityId} | | HTTP Method | POST | | Path Parameters | | Parameter | Description |
|---|
| activityId | Activity instance ID that is assigned to the specified user. |
| | Query String Parameters | | Parameter | Description |
|---|
| variables | Workflow variable value(s) to set. Can be multiple query parameters for many workflow variables. |
| | Sample Response |
{
"activityId": "381_150_expenseclaim_process1_new_claim",
"processId": "150_expenseclaim_process1",
"nextActivityId": "..."
}
|
|
| 3 | Count assignments by username |
Count all assignments of a user via username.
Name | Description |
|---|
| URL | /assignment/countByUser/{username} | | HTTP Method | GET | | Path Parameters | | Parameter | Description |
|---|
| username | Username of a Joget user. |
| | Query String Parameters | | Parameter | Description |
|---|
| appId | Filter assignments by App via App ID. | | processDefId | Filter assignments by belonging process via process definition ID. | | processInstanceId | Filter assignments by process instance via process instance ID. | | activityDefId | Filter assignments by belonging activity via activity definition ID. |
| | Sample Response | |
|
| 4 | Count assignments of current user |
Count all assignments of the currently logged in user.
Name | Description |
|---|
| URL | /assignment/count | | HTTP Method | POST | | Path Parameters | | Parameter | Description |
|---|
| username | Username of a Joget user. | | activityId | Activity instance ID that is assigned to the specified user. |
| | Query String Parameters | | Parameter | Description |
|---|
| variables | Workflow variable value(s) to set. Can be multiple query parameters for many workflow variables. |
| | Sample Response |
{
"activityId": "381_150_expenseclaim_process1_new_claim",
"processId": "150_expenseclaim_process1",
"nextActivityId": "..."
}
|
|
| 5 | |
Get details of an assignment that is assigned to the currently logged in user, via activity instance ID.
Name | Description |
|---|
| URL | /assignment/completeByUser/{username}/{activityId} | | HTTP Method | POST | | Path Parameters | | Parameter | Description |
|---|
| username | Username of a Joget user. | | activityId | Activity instance ID that is assigned to the specified user. |
| | Query String Parameters | | Parameter | Description |
|---|
| variables | Workflow variable value(s) to set. Can be multiple query parameters for many workflow variables. |
| | Sample Response |
{
"activityId": "381_150_expenseclaim_process1_new_claim",
"processId": "150_expenseclaim_process1",
"nextActivityId": "..."
}
|
|
| 6 | Get assignment detail by username |
Get details of an assignment via a username and activity instance ID.
Name | Description |
|---|
| URL | /assignment/completeByUser/{username}/{activityId} | | HTTP Method | POST | | Path Parameters | | Parameter | Description |
|---|
| username | Username of a Joget user. | | activityId | Activity instance ID that is assigned to the specified user. |
| | Query String Parameters | | Parameter | Description |
|---|
| variables | Workflow variable value(s) to set. Can be multiple query parameters for many workflow variables. |
| | Sample Response |
{
"activityId": "381_150_expenseclaim_process1_new_claim",
"processId": "150_expenseclaim_process1",
"nextActivityId": "..."
}
|
|
| 7 | List assignments by username |
List all assignments of a user via username.
Name | Description |
|---|
| URL | /assignment/completeByUser/{username}/{activityId} | | HTTP Method | POST | | Path Parameters | | Parameter | Description |
|---|
| username | Username of a Joget user. | | activityId | Activity instance ID that is assigned to the specified user. |
| | Query String Parameters | | Parameter | Description |
|---|
| variables | Workflow variable value(s) to set. Can be multiple query parameters for many workflow variables. |
| | Sample Response |
{
"activityId": "381_150_expenseclaim_process1_new_claim",
"processId": "150_expenseclaim_process1",
"nextActivityId": "..."
}
|
|
| 8 | List assignments of current user |
List all assignments of the currently logged in user.
Name | Description |
|---|
| URL | /assignment/completeByUser/{username}/{activityId} | | HTTP Method | POST | | Path Parameters | | Parameter | Description |
|---|
| username | Username of a Joget user. | | activityId | Activity instance ID that is assigned to the specified user. |
| | Query String Parameters | | Parameter | Description |
|---|
| variables | Workflow variable value(s) to set. Can be multiple query parameters for many workflow variables. |
| | Sample Response |
{
"activityId": "381_150_expenseclaim_process1_new_claim",
"processId": "150_expenseclaim_process1",
"nextActivityId": "..."
}
|
|
| 9 | Reevaluate assignments by username |
Reevaluate all assignments of a user via username.
Name | Description |
|---|
| URL | /assignment/completeByUser/{username}/{activityId} | | HTTP Method | POST | | Path Parameters | | Parameter | Description |
|---|
| username | Username of a Joget user. | | activityId | Activity instance ID that is assigned to the specified user. |
| | Query String Parameters | | Parameter | Description |
|---|
| variables | Workflow variable value(s) to set. Can be multiple query parameters for many workflow variables. |
| | Sample Response |
{
"activityId": "381_150_expenseclaim_process1_new_claim",
"processId": "150_expenseclaim_process1",
"nextActivityId": "..."
}
|
|
| 10 | Reevaluate assignments of current user |
Reevaluate all assignments of the currently logged in user.
Name | Description |
|---|
| URL | /assignment/completeByUser/{username}/{activityId} | | HTTP Method | POST | | Path Parameters | | Parameter | Description |
|---|
| username | Username of a Joget user. | | activityId | Activity instance ID that is assigned to the specified user. |
| | Query String Parameters | | Parameter | Description |
|---|
| variables | Workflow variable value(s) to set. Can be multiple query parameters for many workflow variables. |
| | Sample Response |
{
"activityId": "381_150_expenseclaim_process1_new_claim",
"processId": "150_expenseclaim_process1",
"nextActivityId": "..."
}
|
|