Assignment API can perform functions to interact or exchange data about task assignments.


NameDescription
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 MethodPOST
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
activityIdActivity instance ID that is assigned to the specified user.
Query String Parameters
ParameterDescription
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 MethodPOST
Path Parameters
ParameterDescription
activityIdActivity instance ID that is assigned to the current user.
Query String Parameters
ParameterDescription
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 MethodGET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Query String Parameters
ParameterDescription
appId

Filter assignments by App via App ID.

processDefIdFilter assignments by belonging process via process definition ID.
processInstanceIdFilter assignments by process instance via process instance ID.
activityDefIdFilter assignments by belonging activity via activity definition ID.
Sample Response
{
  "size": 4
}
4

Count assignments of current user

Count all assignments of the currently logged in user.

Name

Description
URL/assignment/count
HTTP MethodGET
Query String Parameters
ParameterDescription
appId

Filter assignments by App via App ID.

processDefIdFilter assignments by belonging process via process definition ID.
processInstanceIdFilter assignments by process instance via process instance ID.
activityDefIdFilter assignments by belonging activity via activity definition ID.
Sample Response
{
  "size": 3
}
5

Get assignment detail

Get details of an assignment that is assigned to the currently logged in user, via activity instance ID.

Name

Description
URL/assignment/detail/{activityId}
HTTP MethodGET
Path Parameters
ParameterDescription
activityIdActivity instance ID.
Sample Response
6
Get assignment detail by username
Get details of an assignment via a username and activity instance ID.
Name
Description
URL
HTTP Method
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
activityIdActivity instance ID that is assigned to the specified user.
Query String Parameters
ParameterDescription
variables
Workflow variable value(s) to set.
Can be multiple query parameters for many workflow variables.
Sample Response
7
List assignments by username
List all assignments of a user via username.
Name
Description
URL/assignment/completeByUser/{username}/{activityId}
HTTP MethodPOST
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
activityIdActivity instance ID that is assigned to the specified user.
Query String Parameters
ParameterDescription
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 MethodPOST
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
activityIdActivity instance ID that is assigned to the specified user.
Query String Parameters
ParameterDescription
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 MethodPOST
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
activityIdActivity instance ID that is assigned to the specified user.
Query String Parameters
ParameterDescription
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 MethodPOST
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
activityIdActivity instance ID that is assigned to the specified user.
Query String Parameters
ParameterDescription
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": "..."
}