Versions Compared

Old Version 8

changes.mady.by.user Justin

Saved on

compared with

New Version Current

changes.mady.by.user Justin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
borderColorgreen
borderWidth1
titleBGColor#ddffcc
borderStylesolid
titleDefinition

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 AddedImage Removed

Workflow variable value(s) to set.

Can be multiple query parameters for many workflow variables

NameDescription
1

Anchor
Complete assignment by username
Complete assignment by username
Complete assignment by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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
Code Block
languagejs
{
  "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
borderColorblack
bgColor#fbfff5
borderStylesolid

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 MethodPOST
Path Parameters
ParameterDescription
activityIdActivity instance ID that is assigned to the
specified
current user.
Query String Parameters
ParameterDescription
variables

Workflow variable value(s) to set.

Can be multiple query parameters for many workflow variables.

Sample Response
Code Block
languagejs
{
  "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
borderColorblack
bgColor#fbfff5
borderStylesolid

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
Code Block
languagejs
{
  "size": 4
}
4

Anchor
Count assignments of current user
Count assignments of current user
Count assignments of current user

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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
POST
GET
Path
Query String Parameters
ParameterDescription
usernameUsername of a Joget user.
activityIdActivity instance ID that is assigned to the specified user.
Query String Parameters
ParameterDescription
variables
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
Code Block
languagejs
{
  "
activityId
size":
"381_150_expenseclaim_process1_new_claim", "processId": "150_expenseclaim_process1", "nextActivityId": "..."
3
}
5

Anchor
Get assignment detail by username
Get assignment detail by username
Get assignment detail by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/assignment/
completeByUser
detailByUser/{username}/{activityId}
HTTP Method
POST
GET
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
activityIdActivity instance ID that is assigned to the specified user
.Query String ParametersParameterDescriptionvariablesWorkflow variable value(s) to set
.

Can be multiple query parameters for many workflow variables.

Sample Response
Code Block
languagejs
{
  "activityId": "
381
380_
150
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": "
150
380_149_expenseclaim_process1_new_claim",
"nextActivityId
"label": "Claimant Edit",
  "processVersion": "
...
7"
}
6

Anchor
Get assignment detail by usernameof current user
Get assignment detail by usernameof current user
Get assignment detail by usernameof current user

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Get details of an assignment via a username and activity instance IDthat 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.

Name

Description
URL/assignment/
completeByUser/{username}
detail/{activityId}
HTTP Method
POST
GET
Path Parameters
ParameterDescription
username
Username of a Joget user.
activityIdActivity instance ID
that is assigned to the specified user.Query String ParametersParameterDescriptionvariables

Workflow variable value(s) to set.

Can be multiple query parameters for many workflow variables
.
Sample Response
Code Block
languagejs
{
  "activityId": "
381
380_
150
149_expenseclaim_process1_new_claim",
  "variables": {
    "SelectApprover": "admin",
    "status": ""
  },
  "dateCreated": "26-08-2019 07:29 PM",
  "serviceLevelMonitor": "-",
  "processId": "
150
149_expenseclaim_process1",
  "processName": "Expense Approval Process",
  "due": "-",
  "activityName": "Claimant Edit",
  "description": "",
  "id": "380_149_expenseclaim_process1_new_claim",
  "label": "Claimant Edit",
  "
nextActivityId
processVersion": "
...
7"
}
7

Anchor
List assignments by username
List assignments by username
List assignments by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

List all assignments of a user via username.

Name

Description
URL/assignment/
completeByUser
listByUser/{username}
/{activityId}
HTTP Method
POST
GET
Path Parameters
ParameterDescription
usernameUsername of a Joget user
.activityIdActivity instance ID that is assigned to the specified user.Query String ParametersParameterDescriptionvariables
.
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

Workflow variable value(s) to set.

Can be multiple query parameters for many workflow variables
.
Sample Response
Code Block
languagejs
[
  {
    "activityId": "
381
378_
150
147_expenseclaim_process1_
new
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": "
150
378_147_expenseclaim_process1_approve_claim",
    "label": "HOD Approve",
    "
nextActivityId
processVersion": "7"
  },
	...
"
..
}
]
8

Anchor
List assignments of current user
List assignments of current user
List assignments of current user

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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/
completeByUser/{username}/{activityId}
list
HTTP Method
POST
GET
Path
Query String Parameters
ParameterDescription
usernameUsername of a Joget user.activityIdActivity instance ID that is assigned to the specified user.Query String ParametersParameterDescriptionvariables
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

Workflow variable value(s) to set.

Can be multiple query parameters for many workflow variables
.
Sample Response
Code Block
languagejs
[
  {
    "activityId": "
381
378_
150
147_expenseclaim_process1_
new
approve_claim",
    "dateCreated": "26-08-2019 07:29 PM",
    "serviceLevelMonitor": "-",
    "processId": "147_expenseclaim_process1",
    "processName": "Expense Approval Process",
    "due": "
150
-",
    "activityName": "HOD Approve",
    "description": null,
    "id": "378_147_expenseclaim_process1_approve_claim",
    "label": "HOD Approve",
    "
nextActivityId
processVersion": "7"
  },
	...
"
..
}
]
9

Anchor
Reevaluate assignments by username
Reevaluate assignments by username
Reevaluate assignments by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Reevaluate all assignments of a user via username.

Name

Description
URL/assignment/
completeByUser
reevaluateByUsername/{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
Code Block
languagejs
{
  "
activityId
date": "
381_150_expenseclaim_process1_new_claim
Tue Aug 27 18:37:49 SGT 2019",
  "
processId
code": "
150_expenseclaim_process1
200",
  "
nextActivityId
message": "
...
Successful operation"
}
10

Anchor
Reevaluate assignments of current user
Reevaluate assignments of current user
Reevaluate assignments of current user

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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/
completeByUser/{username}/{activityId}
reevaluate
HTTP MethodPOST
Path Parameters
ParameterDescription
usernameUsername of a Joget user.
activityIdActivity instance ID that is assigned to the specified user.
Query String ParametersParameterDescriptionvariables

Workflow variable value(s) to set.

Can be multiple query parameters for many workflow variables.
Parameters

-

Sample Response
Code Block
languagejs
{
  "
activityId
date": "
381_150_expenseclaim_process1_new_claim
Tue Aug 27 18:39:16 SGT 2019",
  "
processId
code": "
150_expenseclaim_process1
200",
  "
nextActivityId
message": "
...
Successful operation"
}