Joget Workflow v6 Beta 4 Released

Check out the latest Joget Workflow v6 Beta for many new features and improvements in user experience (UX), app maintainability and performance.

Skip to end of metadata
Go to start of metadata

Introduced in v5, the API Domain Whitelist setting in General Settings needs to be configured to allow JSON API requests. If a request is from a non-whitelisted domain, the response will be a HTTP 400 Bad Request.

 


App

web/json/app/(*:appId)/(~:version)/form/(*:formId)/columns

Description
Retrieves all columns for a form

User Role

Admin

Method
HTTP GET/POST

Parameters

    • appId - App definition id
    • version - (Optional) App definition version
    • formId - Form definition Id 

Sample URL
http://localhost:8080/jw/web/json/app/crm/form/crm_account/columns

Sample Result

web/json/app/(*:appId)/(~:version)/generator/(*:formId)/generate

Description
Executes a generator plugin based on a form

User Role

Admin

 Method

HTTP POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • plugin - Class name of generator plugin to execute
    • appId - App Definition id
    • version - (Optional) App definition version
    • formId - Form defintion id

Sample URL

http://localhost:8080/jw/web/json/app/crm/generator/crm_account/generate?plugin=org.joget.plugin.enterprise.CrudGenerator

Sample Result

web/json/apps/install

Description
Downloads and imports an app form an URL

User Role

Admin

 Method

HTTP POST

 Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • url - Url to download an app

Sample URL

http://localhost:8080/jw/web/json/apps/install?url=http%3A%2F%2Fwww.joget.org%2Fdownloads%2Fsimple_crm.jwa

Sample Result

 web/json/apps/published/processes

Description
Retrieves all published processes based on logged in user

User Role

Anyone (Including anonymous)

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - (Optional) App definition Id to filter the list

Sample URL

http://localhost:8080/jw/web/json/apps/published/processes?appId=crm

Sample Result

web/json/apps/published/userviews

Description
Retrieves all published userviews based on logged in user

User Role 

Anyone (Including anonymous)

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - (Optional) App definition Id to filter the list

Sample URL 

http://localhost:8080/jw/web/json/apps/published/userviews?appId=crm

Sample Result 

web/json/console/app/list

Description
Retrieves all apps

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • 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 URL

http://localhost:8080/jw/web/json/console/app/list?name=crm

Sample Result

web/json/console/app/(*:appId)/version/list 

Description
Retrieves all version of an app

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition 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 URL

http:/localhost/jw/web/json/workflow/process/list/package

Sample Result

web/json/console/app/(*:appId)/(~:version)/builder/actions 

Description
Retrieves all Datalist Actions plugins

User Role

Admin

Method

HTTP GET/POST

Parameters

    • appID - App Definition Id
    • version - (Optional) App Definition version

Sample URL

http://localhost:8080/jw/web/json/console/app/crm/builder/actions

Sample Result

web/json/console/app/(*:appId)/(~:version)/envVariable/list

Description
Retrieves all environment variable of an app

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definiton Id
    • version- (Optional) App Definiton version
    • filter - (Optional) id filter
    • 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 URL

http://localhost:8080/jw/web/json/console/app/crm/envVariable/list

Sample Result

web/json/console/app/(*:appId)/(~:version)/datalist/list

Description
Retrieves all datalist of an app

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition Id
    • version - (Optional) App Definition version
    • filter - (Optional) name filter
    • 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 URL

http://localhost:8080/jw/web/json/console/app/crm/datalist/list

Sample Result

web/json/console/app/(*:appId)/(~:version)/datalist/options

Description
Retrieves all datalist of an app in value-label pair.

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Defintion Id
    • version - (optional) App Definiton 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 URL

http://localhost:8080/jw/web/json/console/app/crm/datalist/options

Sample Result

web/json/console/app/(*:appId)/(~:version)/form/tableNameList

Description
Retrieves all table name used in an app

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition Id
    • version - (Optional) App Definiton version

Sample URL

http://localhost:8080/jw/web/json/console/app/crm/form/tableNameList

Sample Result

web/json/console/app/(*:appId)/(~:version)/forms

Description
Retrieves all forms in an app

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition version
    • name - (Optional) name filter
    • 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 URL

http://localhost:8080/jw/web/json/console/app/crm/forms

Sample Result

web/json/console/app/(*:appId)/(~:version)/forms/options

Description
Retrieves all form in an app in value-label pair 

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/console/app/crm/forms/options

Sample Result

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

Description
Deploy a new version of XPDL to an app

User Role

Admin

Method

HTTP POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition version
    • packageXpdl - Multipart file of a XPDL file

Sample URL

http://localhost:8080/jw/web/json/console/app/crm/package/deploy

Sample Result

web/json/console/app/(*:appId)/(~:version)/package/xpdl

Description
Retrieves XPDL file of an app

User Role

Admin

Method

HTTP GET/POST

Parameters

    • appId - App Definition id
    • version - (Optional) App Definition version

Sample URL

http://localhost:8080/jw/web/json/console/app/crm/package/xpdl

web/json/console/app/(*:appId)/(~:version)/pluginDefault/list

Description
Retrieves all configured default plugin properties of an app

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition version
    • filter - (Optional) name filter
    • 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 URL

http://localhost:8080/jw/web/json/console/app/crm/pluginDefault/list

Sample Result

web/json/console/app/(*:appId)/(~:version)/message/list

Description
Retrieves all created custom i18n message of an app

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition version
    • filter - (Optional) id and message filter
    • locale - (Optional) language code for filter
    • 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 URL

http://localhost:8080/jw/web/json/console/app/crm/message/list

Sample Result

web/json/console/app/(*:appId)/(~:version)/userview/list

Description
Retrieves all userviews of an app

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition version
    • filter - (Optional) name filter
    • 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 URL

http://localhost:8080/jw/web/json/console/app/crm/userview/list

Sample Result

web/json/console/app/(*:appId)/(~:version)/userview/options

Description
Retrieves all userviews of an app in value-label pair

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition 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 URL

http://localhost:8080/jw/web/json/console/app/crm/userview/options

Sample Result

web/json/workflow/package/list

Description
Retrieves package (app) list

User Role

Admin

Method
HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/workflow/package/list

Sample Result

Assignments 

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

Description
Accept an assigned assignment

Deprecated Since v3, the concept of accept & withdraw assignment is removed  

User Role

Anyone (Including anonymous)

Method

HTTP POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/workflow/assignment/accept/879_223_crm_process1_approve_proposal

Sample Result

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

Description
Completes an assigned assignment

User Role

Anyone (Including anonymous)

Method

HTTP POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/workflow/assignment/complete/879_223_crm_process1_approve_proposal

Sample Result

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

Description
Completes an assigned assignment with option to set workflow variables.

User Role

Anyone (Including anonymous)

Method

HTTP POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • activityId - activity instance id
    • var_* - (Optional) parameters prefixed with "var_" used to set workflow variable

Sample URL

http://localhost:8080/jw/web/json/workflow/assignment/completeWithVariable/879_223_crm_process1_approve_proposal?var_status=Sent

Sample Result

web/json/workflow/assignment/list

Description
Retrieves all assignments of current logged in user

User Role

Anyone (Including anonymous)

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • packageId - (Optional) App Definition Id
    • processDefId - (Optional) Process definition Id with version
    • processId - (Optional) Process instance 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 URL

http://localhost:8080/jw/web/json/workflow/assignment/list?rows=3&packageId=crm

Sample Result

web/json/workflow/assignment/list/count

Description
Retrieves the number of assignments of current logged in user

User Role

Anyone (Including anonymous)

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • packageId - (Optional) App Definition Id
    • processDefId - (Optional) Process definition Id with version
    • processId - (Optional) Process instance id

Sample URL

http://localhost:8080/jw/web/json/workflow/assignment/list/count?packageId=crm

Sample Result

web/json/workflow/assignment/list/accepted

Description
Retrieves all accepted assignments of current logged in user

Deprecated Since v3, the concept of accept & withdraw assignment is removed  

User Role

Anyone (Including anonymous)

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • processId - (Optional) Process instance 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 URL

http://localhost:8080/jw/web/json/workflow/assignment/list/accepted?rows=3

Sample Result

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

Description
Retrieves the number of accepted assignments of current logged in user

Deprecated Since v3, the concept of accept & withdraw assignment is removed  

User Role

Anyone (Including anonymous) 

Method

HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/workflow/assignment/list/accepted/count

Sample Result

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

Description

Retrieves processes list based on accepted assignment of current logged in user

Deprecated Since v3, the concept of accept & withdraw assignment is removed  

User Role 

Anyone (Including anonymous) 

Method

HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/workflow/assignment/list/accepted/process

Sample Result

web/json/workflow/assignment/list/pending

Description
Retrieves all pending assignments of current logged in user 

User Role 

Anyone (Including anonymous)  

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • processId - (Optional) Process instance 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 URL

http://localhost:8080/jw/web/json/workflow/assignment/list/pending

Sample Result

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

Description
Retrieves the number of all pending assignments of current logged in user 

User Role

Anyone (Including anonymous)  

Method 

HTTP GET/POST

Parameters

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

Sample URL 

http://localhost:8080/jw/web/json/workflow/assignment/list/pending/count

Sample Result

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

Description
Retrieves process list based on pending assignments of current logged in user

User Role

Anyone (Including anonymous) 

Method

HTTP GET/POST

Parameters

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

Sample URL 

http:/localhost:8080/jw/web/json/workflow/assignment/list/pending/process

Sample Result

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

Description
Retrieves process information based on available assignment of current logged in user

User Role

Anyone (Including anonymous) 

Method 

HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/workflow/assignment/process/view/208_crm_process1

Sample Result

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

Description
Withdraws an accepted assignment

Deprecated Since v3, the concept of accept & withdraw assignment is removed  

User Role

Anyone (Including anonymous) 

Method

HTTP POST

Parameters

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

Sample URL 

http://localhost:8080/jw/web/json/workflow/assignment/withdraw/879_223_crm_process1_approve_proposal

Sample Result

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

Description
Sets value of workflow variable of an assignment

User Role

Anyone (Including anonymous) 

Method

HTTP POST

Parameters

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

Sample URL 

http://localhost:8080/jw/web/json/workflow/assignment/variable/843_208_crm_process1_send_proposal/status?value=test

Sample Result

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

Description
Retrieves information of an assignment

User Role

Anyone (Including anonymous) 

Method

HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/workflow/assignment/view/843_208_crm_process1_send_proposal

Sample Result

Processes

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

Description
Aborts a running process instance

User Role

Admin

Method
HTTP POST

Parameters

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

Sample URL
http://localhost:8080/jw/web/json/workflow/process/abort/208_crm_process1

Sample Result

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

Description
Gets latest Process def Id of a process based on a Process def Id

User Role

Admin

Method
HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/workflow/process/latest/crm:1:process1

Sample Result

web/json/workflow/process/list

Description
Retrieves process list

User Role

Admin

Method
HTTP GET/POST

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 URL

http://localhost:8080/jw/web/json/workflow/process/list

Sample Result

web/json/workflow/process/list/package

Description
Retrieve first process with details of every packages

User Role

Admin

Method
HTTP GET/POST

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 URL
http:/localhost:8080/jw/web/json/workflow/process/list/package

Sample Result

 

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

Description
Starts a process based on process start whitelist

User Role

Anyone (Including anonymous)  

Method

HTTP POST

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) used to start the previous created but haven't start process instance
    • recordId - (Optional) used to start a process instance with existing record
    • var_* - (Optional) parameters prefixed with "var_" will be used to set workflow variable

Sample URL

http://localhost:8080/jw/web/json/workflow/process/start/crm:3:process1

Sample Result

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

Description
Sets workflow variable of a process instance

User Role

Admin

Method

HTTP POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • processId - process instnace id
    • variable - workflow variable name 
    • value - value of workflow variable to be set

Sample URL

http://localhost:8080/jw/web/json/workflow/process/variable/208_crm_process1/status?value=test

Sample Result

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

Description
Retrieves information of a process definition

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/workflow/process/view/crm:3:process1

Sample Result

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

Description
Retrieves all variables of a process instance

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/workflow/variable/list/208_crm_process1

Sample Result

 

Monitoring

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

Description
Aborts an activity of a process instance

User Role

Admin

Method

HTTP POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/monitoring/activity/abort/208_crm_process1/send_proposal

Sample Result

web/json/monitoring/activity/list

Description
Retrieves a list of all activities

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • processId - (Optional) process instance id for filtering
    • 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 URL

http://localhost:8080/jw/web/json/monitoring/activity/list?processId=116_hr_expense_process1

Sample Result

web/json/monitoring/activity/reassign

Description
Reassigns a user to replace another user assigned to an assignment

User Role

Admin

Method

HTTP POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • username - username that will replace the assigned user
    • replaceUser - username of an existing assignee of the assignment
    • activityId - activity instance id of the assignment

Sample URL

http://localhost:8080/jw/web/json/monitoring/activity/reassign?activityId=841_206_crm_process1_send_proposal&username=admin&replaceUser=cat

Sample Result

web/json/monitoring/activity/reevaluate

Description
Reevaluates an activity

User Role

Admin

Method

HTTP POST

Parameters

    • activityId - activity instance id to be reevaluate

Sample URL

http://localhost:8080/jw/web/json/monitoring/activity/reevaluate?activityId=841_206_crm_process1_send_proposal

 

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

Description
Starts an activity in a running process instance

User Role

Admin

Method

HTTP POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • processId - process instance id
    • activityDefId - activity definition id
    • abortCurrent - (Optional) true of false value to abort all the running activities in the process instance

Sample URL

http://localhost:8080/jw/web/json/monitoring/activity/start/116_hr_expense_process1/verify_claim

Sample Result

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

Description
Sets value to a workflow variable to a running activity instance

User Role

Admin

Method

HTTP POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/monitoring/activity/variable/474_116_hr_expense_process1_approve_claim/status?value=test

Sample Result

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

Description
Retrieves information of an activity instance

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/monitoring/activity/view/474_116_hr_expense_process1_approve_claim

Sample Result

web/json/monitoring/completed/process/list

Description
Retrieves a list of all completed process instances

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • packageId - (Optional) App/ package id
    • processId - (Optional) process instance id for filtering
    • processName - (Optional) process name for filtering
    • 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 URL

http://localhost:8080/jw/web/json/monitoring/completed/process/list?rows=3

Sample Result

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

Description
Copies the state and workflow variables of a running process instance to start a new process instance

User Role

Admin

Method

HTTP POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • processId - process instance id
    • processDefId - process definition id to start a new process (replace "#" to ":")
    • abortCurrent - (Optional) true or false value to abort the current running process instance after start a new process instance

Sample URL

http://localhost:8080/jw/web/json/monitoring/process/copy/116_hr_expense_process1/hr_expense:1:process1

Sample Result

web/json/monitoring/process/variable/(*:processId)/(*:variable)

Description
Sets a value to workflow variable of a process instance

User Role

Admin

Method

HTTP POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/monitoring/process/variable/224_crm_process1/status?value=test

Sample Result

web/json/monitoring/process/view/(*:processId)

Description
Retrieves information of a process instance

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/monitoring/process/view/224_crm_process1

Sample Result

web/json/monitoring/running/activity/complete

Description
Completes a running activity

User Role

Admin

Method

HTTP POST

Parameters

    • processDefId - process definition id (replace "#" to ":")
    • processId - process instance id
    • activityId - activity instance id

Sample URL

http://localhost:8080/jw/web/json/monitoring/running/activity/complete?processDefId=crm:3:process1&processId=224_crm_process1&activityId=885_224_crm_process1_approve_proposal

web/json/monitoring/running/activity/reassign

Description
Reassigns a user to replace another user assigned to an assignment 

User Role

Admin

Method

HTTP POST

Parameters

    • processDefId - process definition id (replace "#" to ":")
    • processId - process instance id
    • activityId - activity instance id
    • username - username that will replace the assigned user
    • replaceUser - username of an existing assignee of the assignment

Sample URL

http://localhost:8080/jw/web/json/monitoring/running/activity/reassign?processDefId=crm:3:process1&processId=227_crm_process1&activityId=890_227_crm_process1_approve_proposal&username=cat&replaceUser=admin

web/json/monitoring/running/process/list

Description
Retrieves a list of all running process instances

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • packageId - (Optional) app/package id
    • processId - (Optional) process instance id
    • 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 URL

http://localhost:8080/jw/web/json/monitoring/running/process/list?packageId=crm&rows=3

Sample Result

web/json/monitoring/user/reevaluate

Description
Reevaluates all assignments of an user

User Role

Admin

Method

HTTP POST

Parameters

    • username - user to be reevaluate

Sample URL

http://localhost:8080/jw/web/json/monitoring/user/reevaluate?username=cat

SLA

web/json/workflow/activity/sla/list

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - (Optional) app defintion id
    • appVersion - (Optional) app definition version
    • processDefId - (Optional) process definition id without package id and version

Sample URL

http://localhost:8080/jw/web/json/workflow/activity/sla/list?appId=crm

Sample Result

Audit Trail

web/json/workflow/audittrail/list

Description
Retrieves a list of audit trail

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • dateFrom - (Optional) date start for filtering. Format is yyyy-MM-dd
    • dateTo - (Optional) date to for filtering. Format is yyyy-MM-dd
    • 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 URL

http://localhost:8080/jw/web/json/workflow/audittrail/list?rows=5

Sample Result

Directory

web/json/directory/admin/dept/list

Description
Retrieves all department

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • orgId - (Optional) orgnization 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 URL

http://localhost:8080/jw/web/json/directory/admin/dept/list

Sample Result

web/json/directory/admin/employment/list

Description
Retrieves all user with employment details

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • orgId - (Optional) organization id
    • deptId - (Optional) department id
    • gradeId - (Optional) grade 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 URL

http://localhost:8080/jw/web/json/directory/admin/employment/list?name=j

Sample Result

web/json/directory/admin/employment/noHaveOrganization/list

Description
Retrieves all users not belong to any organization

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • 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 URL

http://localhost:8080/jw/web/json/directory/admin/employment/noHaveOrganization/list

Sample Result

web/json/directory/admin/employment/noInDept/list

Description
Retrieves all users not belong to a department

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • 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 URL

http://localhost:8080/jw/web/json/directory/admin/employment/noInDept/list?orgId=ORG-001&deptId=D-003&name=j

Sample Result

web/json/directory/admin/employment/noInGrade/list

Description
Retrieves all users not belong to a grade

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • orgId - Organization id
    • gradeId - Grade 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 URL

http://localhost:8080/jw/web/json/directory/admin/employment/noInGrade/list?orgId=ORG-001&gradeId=G-003&name=c

Sample Result

web/json/directory/admin/group/list

Description
Retrieves all groups

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • orgId - (Optional) organization id for filter 
    • 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 URL

http://localhost:8080/jw/web/json/directory/admin/group/list

Sample Result

web/json/directory/admin/grade/list

Description
Retrieves all grades

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • orgId - (Optional) Organization Id for filter
    • 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 URL

http://localhost:8080/jw/web/json/directory/admin/grade/list

Sample Result

web/json/directory/admin/organization/list

Description
Retrieves all organizations

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • 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 URL

http://localhost:8080/jw/web/json/directory/admin/organization/list

Sample Result

web/json/directory/admin/subdept/list

Description
Retrieves all sub department of a department

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • deptId - department 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 URL

http://localhost:8080/jw/web/json/directory/admin/subdept/list?deptId=D-001

Sample Result

web/json/directory/admin/user/deptAndGrade/options

Description
Retrieves all departments and grades in an organization

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/directory/admin/user/deptAndGrade/options?orgId=ORG-001

Sample Result 

web/json/directory/admin/user/group/list

Description
Retrieves the groups that a user is in or not in.

User Role 

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • userId - Username that a user is in or not in the group
    • orgId - (Optional) 
    • inGroup - (Optional) true or false. default to true
    • 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 URL

http://localhost:8080/jw/web/json/directory/admin/user/group/list?userId=admin

Sample Result 

web/json/directory/admin/user/list

Description
Retrieves a list of users

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • orgId - (Optional) Organization id for filter
    • deptId - (Optional) Department id for filter
    • gradeId - (Optional) Grade id for filter
    • groupId - (Optional) Group id for filter
    • roleId - (Optional) Role id for filter
    • active - (Optional) 1 = active, 0 = not active
    • 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 URL

http://localhost:8080/jw/web/json/directory/admin/user/list?groupId=G-002

Sample Result

web/json/directory/admin/user/notInGroup/list

Description
Retrieves a list of user not in a group

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • groupId - Group id for filter
    • 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 URL

http://localhost:8080/jw/web/json/directory/admin/user/notInGroup/list?groupId=G-002

Sample Result

web/json/directory/user/sso

Description
To single sign on a user

User Role

Anonymous

Method

HTTP GET/POST, support HTTP basic authentication

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • username - (Optional) username for login
    • password - (Optional) password for login
    • hash - (Optional) Hashed Password

Sample URL

http://localhost:8080/jw/web/json/directory/user/sso?username=admin&password=admin

Sample Result

web/json/workflow/currentUsername

Description
Retrieves the username of current logged in user

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

http://localhost:8080/jw/web/json/workflow/currentUsername

Sample Result

Plugin

web/json/plugin/list

Description
Retrieves a list of plugins

User Role

Admin

Method

HTTP GET/POST

Parameters

Sample URL

http://localhost:8080/jw/web/json/plugin/list?start=0&rows=5

Sample Result 

web/json/plugin/listOsgi

Description
Retrieves a list of OSGI plugins

User Role

Admin

Method

HTTP GET/POST

Parameters

Sample URL

http://localhost:8080/jw/web/json/plugin/listOsgi?start=0&rows=10

Sample Result 

web/property/json/getElements

Description
Retrieves options of plugins based on a plugin type abstract class or interface

User Role

Admin

Method

HTTP GET/POST

Parameters

Sample URL

http://localhost:8080/jw/web/property/json/getElements?classname=org.joget.plugin.base.DefaultApplicationPlugin

Sample Result

web/property/json/getPropertyOptions

Description
Retrieves the Plugin Properties Options of a plugin

User Role

Admin

Method

HTTP GET/POST

Parameters

    • value - Plugin class name

Sample URL

http://localhost:8080/jw/web/property/json/getPropertyOptions?value=org.joget.apps.app.lib.BeanShellTool

Sample Result 

web/property/json/(*:appId)/(~:version)/getDefaultProperties

Description
Retrieves the default Plugin Properties Options of a plugin based on App Definition meta

User Role

Admin

Method

HTTP GET/POST

Parameters

    • appId - App Definition Id
    • version - (Optional) App Defintion version
    • value - Plugin class name

Sample URL

http://localhost:8080/jw/web/property/json/crm/getDefaultProperties?value=org.joget.apps.app.lib.EmailTool

Sample Result

web/property/json/(*:appId)/(~:version)/getPropertyOptions

Description
Retrieves the Plugin Properties Options of a plugin with App Definition meta

User Role

Admin

Method

HTTP GET/POST

Parameters

    • appId - App Definition Id
    • version - (Optional) App Defintion version
    • value - Plugin class name

Sample URL

http://localhost:8080/jw/web/property/json/crm/getPropertyOptions?value=org.joget.apps.app.lib.BeanShellTool

Sample Result 

System

web/json/apps/verify

Description
Verifies a URL is valid

User Role

Admin

Method
HTTP HEAD

Parameters

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

Sample URL
http://localhost:8080/jw/web/json/apps/verify?url=http%3A%2F%2Fwww.joget.org

web/json/console/setting/message/list

Description
Retrieves all messages added in Manage Messages

User Role

Admin

Method
HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • filter - (Optional) string to filter the results
    • locale - (Optional) language code to filter the results
    • 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 URL
http://localhost:8080/jw/web/json/console/setting/message/list

Sample Result 

web/json/hash/options

Description
Retrieves all available Hash Variable syntax

User Role

Admin

Method
HTTP GET/POST

Sample URL
http://localhost:8080/jw/web/json/hash/options

Sample Result 

web/json/workflow/testConnection

Description
To tests a JDBC connection

User Role

Admin

Method
HTTP GET/POST

Parameters

    • datasource - Profile name. Not used.
    • driver - driver name 
    • url - connection URL
    • user - username
    • password - password
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method

Sample URL
http://localhost:8080/jw/web/json/workflow/testConnection?datasource=default&driver=com.mysql.jdbc.Driver&url=jdbc%3Amysql%3A%2F%2Flocalhost%3A3306%2Fjwdb%3FcharacterEncoding%3DUTF-8&user=root&password=

Sample Result 


 

  • No labels