Definition

Assignment API can interact with task assignments of the current user or a specified user.


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.

This API method only works for Basic Access Authentication.

See here on how to configure this setting in Manage API Key userview menu.

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.

This API method only works for Basic Access Authentication.

See here on how to configure this setting in Manage API Key userview menu.

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 by username

Get details of an assignment via a username and activity instance ID.

Name

Description
URL/assignment/detailByUser/{username}/{activityId}
HTTP MethodGET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
activityIdActivity instance ID that is assigned to the specified user.
Sample Response
{
  "activityId": "380_149_expenseclaim_process1_new_claim",
  "variables": {
    "SelectApprover": "admin",
    "status": ""
  },
  "dateCreated": "26-08-2019 07:29 PM",
  "serviceLevelMonitor": "-",
  "processId": "149_expenseclaim_process1",
  "processName": "Expense Approval Process",
  "due": "-",
  "activityName": "Claimant Edit",
  "description": "",
  "id": "380_149_expenseclaim_process1_new_claim",
  "label": "Claimant Edit",
  "processVersion": "7"
}
6

Get assignment detail of current user

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

This API method only works for Basic Access Authentication.

See here on how to configure this setting in Manage API Key userview menu.

Name

Description
URL/assignment/detail/{activityId}
HTTP MethodGET
Path Parameters
ParameterDescription
activityIdActivity instance ID.
Sample Response
{
  "activityId": "380_149_expenseclaim_process1_new_claim",
  "variables": {
    "SelectApprover": "admin",
    "status": ""
  },
  "dateCreated": "26-08-2019 07:29 PM",
  "serviceLevelMonitor": "-",
  "processId": "149_expenseclaim_process1",
  "processName": "Expense Approval Process",
  "due": "-",
  "activityName": "Claimant Edit",
  "description": "",
  "id": "380_149_expenseclaim_process1_new_claim",
  "label": "Claimant Edit",
  "processVersion": "7"
}
7

List assignments by username

List all assignments of a user via username.

Name

Description
URL/assignment/listByUser/{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.
sort

Assignments data column to sort.

Must be used in conjunction with "sortDescending" parameter.

sortDescending

Sort the specified "sort" parameter value in ascending or descending order.

Expects a boolean value.

Must be used in conjunction with "sort" parameter.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
[
  {
    "activityId": "378_147_expenseclaim_process1_approve_claim",
    "dateCreated": "26-08-2019 07:29 PM",
    "serviceLevelMonitor": "-",
    "processId": "147_expenseclaim_process1",
    "processName": "Expense Approval Process",
    "due": "-",
    "activityName": "HOD Approve",
    "description": null,
    "id": "378_147_expenseclaim_process1_approve_claim",
    "label": "HOD Approve",
    "processVersion": "7"
  },
	.....
]
8

List assignments of current user

List all assignments of the currently logged in user.

This API method only works for Basic Access Authentication.

See here on how to configure this setting in Manage API Key userview menu.

Name

Description
URL/assignment/list
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.
sort

Assignments data column to sort.

Must be used in conjunction with "sortDescending" parameter.

sortDescending

Sort the specified "sort" parameter value in ascending or descending order.

Expects a boolean value.

Must be used in conjunction with "sort" parameter.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
[
  {
    "activityId": "378_147_expenseclaim_process1_approve_claim",
    "dateCreated": "26-08-2019 07:29 PM",
    "serviceLevelMonitor": "-",
    "processId": "147_expenseclaim_process1",
    "processName": "Expense Approval Process",
    "due": "-",
    "activityName": "HOD Approve",
    "description": null,
    "id": "378_147_expenseclaim_process1_approve_claim",
    "label": "HOD Approve",
    "processVersion": "7"
  },
	.....
]
9

Reevaluate assignments by username

Reevaluate all assignments of a user via username.

Name

Description
URL/assignment/reevaluateByUsername/{username}
HTTP MethodPOST
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
Sample Response
{
  "date": "Tue Aug 27 18:37:49 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
10

Reevaluate assignments of current user

Reevaluate all assignments of the currently logged in user.

This API method only works for Basic Access Authentication.

See here on how to configure this setting in Manage API Key userview menu.

Name

Description
URL/assignment/reevaluate
HTTP MethodPOST
Parameters

-

Sample Response
{
  "date": "Tue Aug 27 18:39:16 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}




  • No labels