Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


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.

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
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.

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

Anchor
Get assignment detail
Get assignment detail
Get assignment detail

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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
Code Block
languagejs
{
  "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 by username
Get assignment detail by username
Get assignment detail by username

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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.
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": "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
borderColorblack
bgColor#fbfff5
borderStylesolid

List all assignments of a user via username.

Name

Description
URL/assignment/completeByUserlistByUser/{username}/{activityId}
HTTP MethodPOSTGET
Path Parameters
Activity instance ID that is assigned to the specified
ParameterDescription
usernameUsername of a Joget user.activityId user.
Query String Parameters
ParameterDescription
variables

Workflow variable value(s) to set.

Can be multiple query parameters for many workflow 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.
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
Code Block
languagejs
Sample Response
{ "activityId": "381_150_expenseclaim_process1_new_claim", "processId": "150_expenseclaim_process1", "nextActivityId": "..." }
Code Block
languagejs
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.

Name

Description
URL/assignment/completeByUser/{username}/{activityId}
HTTP MethodPOSTGET
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": "..."
}
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/{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": "..."
}
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.

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": "..."
}

...