Joget DX Preview Release Available for Download

Check out Joget DX, the next generation successor to Joget Workflow for faster, simpler digital transformation.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 26 Current »

web/json/console/app/(:appId)/(:version)/package/deploy

URL
/web/json/workflow/package/deploy

Method
HTTP POST

Description
Workflow package deploy

Parameters

appId - app ID
version - app version
packageXpdl - XPDL file

Sample Result


web/json/workflow/package/list

URL
/web/json/workflow/package/list

Method
HTTP GET

Description
Retrieve package (app) list

Parameters

  • callback - a function (in JavaScript) to call back after invoking this method

Sample Result


web/json/workflow/process/list

URL
/web/json/workflow/process/list

Method
HTTP GET

Description
Retrieve process list

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • allVersion - (Optional) "yes" to load all versions, "no" to load latest version
  • packageId - (Optional) package id (App id)
  • sort - (Optional) column name to be sorted
  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
  • start - (Optional) where rows start from
  • rows - (Optional) number of rows per page
  • checkWhiteList - (Optional true/false) to return the list based on process white list

Sample Result


web/json/workflow/process/list/package

URL
/web/json/workflow/process/list/package

Method
HTTP GET

Description
Retrieve process list for process tree

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample Result


web/json/workflow/process/latest/(:processDefId)

URL
/web/json/workflow/process/latest/(:processDefId)

Method
HTTP GET

Description
Get latest Process def Id

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processDefId - Process Definition Id (Replace '#' with ':' in the id)

Sample Result


web/json/workflow/process/view/(:processDefId)

URL
/web/json/workflow/process/view/(:processDefId)

Method
HTTP GET

Description
View selected process

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processDefId - Process Definition Id (Replace '#' with ':' in the id)

Sample Result


web/json/workflow/process/start/(:processDefId)

URL
/web/json/workflow/process/start/(:processDefId)

Method
HTTP POST

Description
Start process instance

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processDefId - Process Definition Id (Replace '#' with ':' in the id)
  • processInstanceId - (Optional) start process with an instanceId
  • var_(workflow variable id) - (Optional) set workflow variable value 

Sample Result

The return of "activityId" is based on the value of "Show The Next Assignment When Completed" under "Run Process" in the activity mapping page. It also depends on whether an assignment exists for the current logged in user or not.


web/json/workflow/process/abort/(:processId)

URL
/web/json/workflow/process/abort/(:processId)

Method
HTTP POST

Description
Abort process instance

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processId - process id

Sample Result


web/json/workflow/process/variable/(:processId)/(:variable)

URL
/web/json/workflow/process/variable/(:processId)/(:variable)

Method
HTTP GET

Description
Get process workflow variable

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processId - process id
  • variable - variable id

Sample Result


web/json/workflow/assignment/list/pending/count

URL
/web/json/workflow/assignment/list/pending/count

Method
HTTP GET

Description
Retrieve total size of assignment pending list

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method

Sample Result


web/json/workflow/assignment/list/accepted/count

URL
/web/json/workflow/assignment/list/accepted/count

Method
HTTP GET

Description
Retrieve total size of assignment accepted list

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method

Sample Result


web/json/workflow/assignment/list/count

URL
/web/json/workflow/assignment/list/count

Method
HTTP GET

Description
Retrieve total size of assignment pending accepted list

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method

Sample Result


web/json/workflow/assignment/list/pending

URL
/web/json/workflow/assignment/list/pending

Method
HTTP GET

Description
Retrieve workflow assignment pending list

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processId - (Optional) process definition (Replace '#' with ":" in id)
  • sort - (Optional) column name to be sorted
  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
  • start - (Optional) where rows start from
  • rows - (Optional) number of rows per page

Sample Result


web/json/workflow/assignment/list/accepted

URL
/web/json/workflow/assignment/list/accepted

Method
HTTP GET

Description
Retrieve workflow assignment accepted list

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processId - (Optional) process definition id (Replace '#' with ":" in id)
  • sort - (Optional) column name to be sorted
  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
  • start - (Optional) where rows start from
  • rows - (Optional) number of rows per page

Sample Result


web/json/workflow/assignment/list

URL
/web/json/workflow/assignment/list

Method
HTTP GET

Description
Retrieve workflow assignment pending accepted list

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • packageId- (Optional) Package id /App Id
  • processDefId- (Optional) Process Definition Id with version
  • sort - (Optional) column name to be sorted
  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
  • start - (Optional) where rows start from
  • rows - (Optional) number of rows per page

Sample Result


web/json/workflow/assignment/list/pending/process

URL
/web/json/workflow/assignment/list/pending/process

Method
HTTP GET

Description
Retrieve workflow assignment pending list for tree

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample Result


web/json/workflow/assignment/list/accepted/process

URL
/web/json/workflow/assignment/list/accepted/process

Method
HTTP GET

Description
Retrieve workflow assignment accepted list for tree

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample Result


web/json/workflow/assignment/view/(:activityId)

URL
/web/json/workflow/assignment/view/(:activityId)

Method
HTTP GET

Description
Retrieve workflow assignment view

Parameters

  • callback - a function (in JavaScript) to call back after invoking this method
  • activityId - activity id

Sample Result


web/json/workflow/assignment/process/view/(:processId)

URL
/web/json/workflow/assignment/process/view/(:processId)

Method
HTTP GET

Description
Retrieve the first workflow assignment view of the currently logged in user.

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processId - Process Instance ID

Sample Result


web/json/workflow/assignment/accept/(:activityId)

URL
/web/json/workflow/assignment/accept/(:activityId)

Method
HTTP POST

Description
Retrieve workflow assignment accept

Parameters

  • callback - a function (in JavaScript) to call back after invoking this method
  • activityId - activity id

Sample Result


web/json/workflow/assignment/withdraw/(:activityId)

URL
/web/json/workflow/assignment/withdraw/(:activityId)

Method
HTTP POST

Description
Withdraw activity

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • activityId - activity id

Sample Result


web/json/workflow/assignment/variable/(:activityId)/(:variable)

URL
/web/json/workflow/assignment/variable/(:activityId)/(:variable)

Method
HTTP POST

Description
Set activity variable

Parameters

  • callback - a function (in JavaScript) to call back after invoking this method
  • activityId - activity id
  • variable - variable
  • value - value

Sample Result


web/json/workflow/assignment/completeWithVariable/(:activityId)

URL
/web/json/workflow/assignment/completeWithVariable/(:activityId)

Method
HTTP POST

Description
Set activity variable while completing an assignment activity
Variables can be passed as parameters with the var_ prefix

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • activityId - activity id
  • var_(workflow variable id) - (Optional) set workflow variable value

Sample Code

Sample Result


web/json/workflow/assignment/complete/(:activityId)

URL
/web/json/workflow/assignment/complete/(:activityId)

Method
HTTP POST

Description
Complete assignment activity

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • activityId - Activity id

Sample Result


web/json/workflow/variable/list/(*:processId)

URL
/web/json/workflow/variable/list/(*:processId)

Method
HTTP GET

Description
Retrieve workflow variable of a process. 

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processId - Process id

Sample Result


web/json/workflow/process/sla/list

URL
/web/json/workflow/process/sla/list

Method
HTTP GET

Description
Retrieve process SLA list; works only with Process Data Collector Plugin

Parameters

  • appId - app id
  • appVersion - app version

Sample Result


web/json/workflow/activity/sla/list

URL
/web/json/workflow/activity/sla/list

Method
HTTP GET

Description
Retrieve activity SLA list.

Prerequisites: Works only with Process Data Collector Plugin enabled.

Parameters

  • appId - app id
  • appVersion - app version
  • processDefId - (Optional) process definition id without version

Sample Result


web/json/monitoring/running/process/list

URL
/web/json/monitoring/running/process/list

Method
HTTP GET

Description
Retrieve running process list

Parameters

  • packageId - (Optional) package id
  • processId - (Optional) process definition id without version
  • processName - (Optional) process name
  • version - (Optional) process version
  • sort - (Optional) column name to be sorted
  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
  • start - (Optional) where rows start from
  • rows - (Optional) number of rows per page

Sample Result


web/json/monitoring/completed/process/list

URL
/web/json/monitoring/completed/process/list

Method
HTTP GET

Description
Retrieve completed process list

Parameters

  • packageId - (Optional) package id
  • processId - (Optional) process definition id without version
  • processName - (Optional) process name
  • version - (Optional) process version
  • sort - (Optional) column name to be sorted
  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
  • start - (Optional) where rows start from
  • rows - (Optional) number of rows per page

Sample Result


web/json/monitoring/process/copy/(:processId)/(:processDefId)

URL
/web/json/monitoring/process/copy/(:processId)/(:processDefId)

Method
HTTP POST

Description
Start a process instance with a copy over workflow variable from a running process, and start matching running activity in the new process instance

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processId - process id
  • processDefId - process definition id
  • abortCurrent - (Optional) Boolean value to indicate whether to abort the running process instance or not

Sample Result


web/json/monitoring/activity/list

URL
/web/json/monitoring/activity/list

Method
HTTP GET

Description
Retrieve monitoring activity list

Parameters

  • processId - (Optional) process id
  • sort - (Optional) column name to be sorted
  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
  • start - (Optional) where rows start from
  • rows - (Optional) number of rows per page

Sample Result


web/json/monitoring/activity/reevaluate

URL
/web/json/monitoring/activity/reevaluate

Method
HTTP POST

Description
Evaluate assignment for activity

Parameters

  • activityId - Activity id

Sample Result

-


web/json/monitoring/activity/variable/(:activityId)/(:variable)

URL
/web/json/monitoring/activity/variable/(:activityId)/(:variable)
Method
HTTP POST

Description
Set value for variable

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • activityId - Activity id
  • variable - Variable
  • value - Value

Sample Result


web/json/monitoring/activity/view/(:activityId)

URL
/web/json/monitoring/activity/view/(:activityId)

Method
HTTP GET

Description
Retrieve workflow activity view

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • activityId - Activity id

Sample Result


web/json/monitoring/activity/abort/(:processId)/(:activityDefId)

URL
/web/json/monitoring/activity/abort/(:processId)/(:activityDefId)
Method
HTTP POST

Description
Abort an activity in a process

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processId - process id
  • activityDefId - activity definition id

Sample Result


web/json/monitoring/activity/start/(:processId)/(:activityDefId)

URL
/web/json/monitoring/activity/start/(:processId)/(:activityDefId)
Method
HTTP POST

Description
Start an activity in a process

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processId - process id
  • activityDefId - activity definition id
  • abortCurrent - (Optional) Boolean value to indicate whether to abort current running activity or not

Sample Result


web/json/monitoring/activity/reassign

URL
/web/json/monitoring/activity/reassign

Method
HTTP POST

Description
Reassign assignee in an assignment

Parameters

  • activityId- activity Instance ID
  • username- new assignee (username)
  • replaceUser- assignee to be replaced (username)
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method

Sample Result


web/json/monitoring/user/reevaluate

URL
/web/json/monitoring/user/reevaluate

Method
HTTP POST

Description
Evaluate assignments for a user

Parameters

  • username - Username

Sample Result

-


web/json/workflow/currentUsername

URL
/web/json/workflow/currentUsername

Method
HTTP GET

Description
Get current logged in user's username

Parameters

  • callback - (Optional) a function (in JavaScript) to call back after invoking this method

Sample Result


web/json/apps/published/userviews

URL
/web/json/apps/published/userviews

Method
HTTP GET

Description
Get a list of published user views

Parameters

  • appId - (Optional) App ID
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method

Sample Result


web/json/apps/published/processes

URL
/web/json/apps/published/processes

Method
HTTP GET

Description
Get a list of published processes

Parameters

  • appId - (Optional) app ID
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method

Sample Result

  • No labels