Page History

Panel

borderColor	green
borderWidth	1
titleBGColor	#ddffcc
borderStyle	solid
title	Definition

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

...

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

Image Added

Name

Description

1

Anchor

	Complete assignment by username
	Complete assignment by username

Complete assignment by username

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Code Block

language	js

{
  "activityId": "381_150_expenseclaim_process1_new_claim",
  "processId": "150_expenseclaim_process1",
  "nextActivityId": "..."
}

2

Anchor

	Complete assignment of current user
	Complete assignment of current user

Complete assignment of current user

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Complete an assignment of the currently logged in user, to continue the flow of a process instance.

Warning

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 Method

POST

Path Parameters

Parameter	Description
activityId	Activity instance ID that is assigned to the current user.

Query String Parameters

Parameter

Description

variables

Workflow variable value(s) to set.

Can be multiple query parameters for many workflow variables.

Sample Response

Code Block

language	js

{
  "activityId": "381_150_expenseclaim_process1_new_claim",
  "processId": "150_expenseclaim_process1",
  "nextActivityId": "..."
}

3

Anchor

	Count assignments by username
	Count assignments by username

Count assignments by username

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Code Block

language	js

{
  "size": 4
}

4

Anchor

	Count assignments of current user
	Count assignments of current user

Count assignments of current user

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Count all assignments of the currently logged in user.

Warning

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 Method

GET

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

Code Block

language	js

{
  "size": 3
}

5

Anchor

	Get assignment detail by username
	Get assignment detail by username

Get assignment detail by username

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/assignment/detailByUser/{username}/{activityId}

HTTP Method

GET

Path Parameters

Parameter	Description
username	Username of a Joget user.
activityId	Activity instance ID that is assigned to the specified user.

Sample Response

Code Block

language	js

{
  "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

Anchor

	Get assignment detail of current user
	Get assignment detail of current user

Get assignment detail of current user

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Warning

This API method only works for Basic Access Authentication.

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

Get assignment detail by username

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

Name

Description

URL

/assignment/detail/{activityId}

HTTP Method

GET

Path Parameters

Parameter	Description
activityId	Activity instance ID.

Sample Response

Code Block

language	js

{
  "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

Anchor

	List assignments by username
	List assignments by username

List assignments by username

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

List assignments by username

List all assignments of a user via username.

Name

Description

URL

/assignment/listByUser/{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.
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.
startOffset	Starting position of records to start query. Expects an integer.
pageSize	Number of results to return. Expects an integer.

Sample Response

Code Block

language	js

[
  {
    "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

Anchor

	List assignments of current user
	List assignments of current user

List assignments of current user

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

List all assignments of the currently logged in user.

Warning

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 Method

GET

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.
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.
startOffset	Starting position of records to start query. Expects an integer.
pageSize	Number of results to return. Expects an integer.

Sample Response

Code Block

language	js

[
  {
    "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

Anchor

	Reevaluate assignments by username
	Reevaluate assignments by username

Reevaluate assignments by username

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Reevaluate all assignments of a user via username.

Name

Description

URL

/assignment/reevaluateByUsername/{username}

HTTP Method

POST

Path Parameters

Parameter	Description
username	Username of a Joget user.

Sample Response

Code Block

language	js

{
  "date": "Tue Aug 27 18:37:49 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}

10

Anchor

	Reevaluate assignments of current user
	Reevaluate assignments of current user

Reevaluate assignments of current user

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Reevaluate all assignments of the currently logged in user.

Warning

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 Method

POST

Parameters

-

Sample Response

Code Block

language	js

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

Space shortcuts

Page tree

Versions Compared

Old Version 5

New Version Current

Key