Page History

App

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

Description
Retrieves all columns for a form

...

- 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

Code Block

language	js

[{
    "value": "accountName",
    "label": "Account Name"
}, {
    "value": "address",
    "label": "address"
}, {
    "value": "city",
    "label": "City"
}, {
    "value": "country",
    "label": "Country"
}, {
    "value": "dateCreated",
    "label": "Date Created"
}, {
    "value": "dateModified",
    "label": "Date Modified"
}, {
    "value": "id",
    "label": "ID"
}, {
    "value": "state",
    "label": "State"
}]

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

Code Block

language	js

{
    "message": "CRUD generated. Click <a href=\"/jw/web/console/app/crm/2/userview/builder/crm_userview_sales?menuId=c4a0c79c-c0a83810-5291318b-96650e7d\" target=\"_blank\">here<\/a> to continue edit CRUD in Userview Builder.",
    "error": false,
    "pluginDisabled": false
}

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

Code Block

language	js

{
    "appId" : "mcrm",
    "appName" : "Simple CRM",
    "appVersion: : "1"
}

web/json/apps/published/processes

Description
Retrieves all published processes based on logged in user

...

- 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

Code Block

language	js

{
    "apps": [{
        "processes": [{
            "id": "crm#3#process1",
            "processVersion": "3",
            "appVersion": 2,
            "name": "Proposal Approval Process",
            "idWithoutVersion": "process1",
            "url": "/jw/web/client/app/crm/2/process/process1?start=true"
        }],
        "id": "crm",
        "name": "CRM",
        "version": 2
    }]
}

web/json/apps/published/userviews

Description
Retrieves all published userviews based on logged in user

...

- 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

Code Block

language	js

{
    "apps": [{
        "id": "crm",
        "name": "CRM",
        "userviews": [{
            "id": "crm_userview_sales",
            "description": "",
            "name": "CRM: Sales Force Automation",
            "url": "/jw/web/userview/crm/crm_userview_sales",
            "version": 2
        }],
        "version": 2
    }]
}

web/json/console/app/list

Description
Retrieves all apps

...

- 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

Code Block

language	js

{
    "total": 2,
    "data": [{
        "id": "crm",
        "name": "CRM",
        "version": 2
    }, {
        "id": "mcrm",
        "name": "Simple CRM",
        "version": 1
    }]
}

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

Description
Retrieves all version of an app

...

- 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

Code Block

language	js

{
    "total": 2,
    "data": [{
        "dateModified": "23-07-2015 07:25 AM",
        "description": null,
        "dateCreated": "28-05-2015 10:08 PM",
        "published": "",
        "version": "1"
    }, {
        "dateModified": "04-09-2015 03:05 AM",
        "description": null,
        "dateCreated": "22-07-2015 11:24 PM",
        "published": "<div class=\"tick\"><\/div>",
        "version": "2"
    }]
}

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

Description
Retrieves all Datalist Actions plugins

...

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

Sample URL

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

Sample Result

Code Block

language	js

{
    "actions": [{
        "name": "Data List Hyperlink Action",
        "className": "org.joget.apps.datalist.lib.HyperlinkDataListAction",
        "label": "Hyperlink",
        "type": "text",
        "propertyOptions": "[{     title : 'Configure Link',     properties : [{         label : 'Hyperlink',         name : 'href',         type : 'textfield',         description : 'URL (Eg. http:\\/\\/www.google.com)'     },     {         label : 'Hyperlink Target',         name : 'target',         type : 'selectbox',         description : 'Hyperlink Target is for Row Action usage only',         options : [{             value : '_self',             label : 'Current Window'         },         {             value : '_blank',             label : 'New Window'         },         {             value : 'popup',             label : 'Popup Dialog'         }]     },     {         name : 'parameters',         label : 'Hyperlink Parameters',         type : 'gridCombine',         columns : [{             key : 'hrefParam',             label : 'Parameter Name'         },         {             key : 'hrefColumn',             label : 'Column Name'         }]     },     {         label : 'Label',         name : 'label',         type : 'textfield',         description : 'Label shown in the column (for row actions)',         value : 'Hyperlink'     },     {         label : 'Confirmation Message',         name : 'confirmation',         type : 'textfield'     },     {         label : 'Visible when no record or checkbox? ',         name : 'visible',         type : 'checkbox',         options : [             {'value' : 'true', 'label' : ''}         ]     }] }]"
    }, {
        "name": "Form Row Delete Action",
        "className": "org.joget.apps.datalist.lib.FormRowDeleteDataListAction",
        "label": "Delete",
        "type": "text",
        "propertyOptions": "[{     title : 'Edit Delete Action',     properties : [{         name : 'label',         label : 'Label',         type : 'textfield'     },     {name:'formDefId',label:'Form',type:'selectbox',options_ajax:'[CONTEXT_PATH]/web/json/console/app/crm/2/forms/options',required:'True'},{         name : 'confirmation',         label : 'Confirmation Message',         type : 'textfield'     },     {         name:'deleteGridData',         label:'Delete Associated Grid Data?',         type:'checkbox',         value:'false',         options:[             {                 value:'true',                 label:''             }         ]     },     {         name:'deleteSubformData',         label:'Delete Associated Child Form Data? ',         type:'checkbox',         value:'false',         options:[             {                 value:'true',                 label:''             }         ]     },     {         name:'abortRelatedRunningProcesses',         label:'Abort Related Running Processes? ',         type:'checkbox',         value:'false',         options:[             {                 value:'true',                 label:''             }         ]     }] }]"
    }]
}

...

- 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

Code Block

language	js

{
    "total": 2,
    "data": [{
        "id": "refNo",
        "value": "75",
        "remarks": "Used for plugin: IdGeneratorField"
    }, {
        "id": "welcome",
        "value": "<b>Welcome Message<\/b>",
        "remarks": ""
    }]
}

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

Description
Retrieves all datalist of an app

...

- 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

Code Block

language	js

{
    "total": 3,
    "data": [{
        "id": "crm_contact_list",
        "dateModified": "22-07-2015 11:24 PM",
        "description": "Contact List",
        "name": "Contact List",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_inbox",
        "dateModified": "28-08-2015 09:42 AM",
        "description": null,
        "name": "Task Inbox",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_opportunity_list",
        "dateModified": "22-07-2015 11:24 PM",
        "description": "Opportunity List",
        "name": "Opportunity List",
        "dateCreated": "22-07-2015 11:24 PM"
    }]
}

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

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

...

- 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

Code Block

language	js

[{
    "value": "",
    "label": ""
}, {
    "value": "crm_account_list",
    "label": "Account Listing"
}, {
    "value": "crm_contact_list",
    "label": "Contact List"
}, {
    "value": "crm_opportunity_list",
    "label": "Opportunity List"
}, {
    "value": "crm_inbox",
    "label": "Task Inbox"
}]

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

Description
Retrieves all table name used in an app

...

- 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

Code Block

language	js

{
    "tableName": ["crm_account", "crm_contact", "crm_opportunity", "crm_proposal"]
}

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

Description
Retrieves all forms in an app

...

- 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

Code Block

language	js

{
    "total": 7,
    "data": [{
        "id": "crm_account",
        "dateModified": "07-09-2015 08:30 AM",
        "tableName": "crm_account",
        "name": "Account Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_contact",
        "dateModified": "22-07-2015 11:24 PM",
        "tableName": "crm_contact",
        "name": "Contact Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_opportunity",
        "dateModified": "22-07-2015 11:24 PM",
        "tableName": "crm_opportunity",
        "name": "Opportunity Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_proposal_approval_form",
        "dateModified": "22-07-2015 11:24 PM",
        "tableName": "crm_proposal",
        "name": "Proposal Approval Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_proposal_form",
        "dateModified": "13-08-2015 02:55 AM",
        "tableName": "crm_proposal",
        "name": "Proposal Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_proposal_resubmit_form",
        "dateModified": "22-07-2015 11:24 PM",
        "tableName": "crm_proposal",
        "name": "Proposal Resubmit Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_proposal_sending_form",
        "dateModified": "22-07-2015 11:24 PM",
        "tableName": "crm_proposal",
        "name": "Proposal Sending Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }]
}

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

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

...

- 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

Code Block

language	js

[{
    "value": "",
    "label": ""
}, {
    "value": "crm_account",
    "label": "Account Form"
}, {
    "value": "crm_contact",
    "label": "Contact Form"
}, {
    "value": "crm_opportunity",
    "label": "Opportunity Form"
}, {
    "value": "crm_proposal_approval_form",
    "label": "Proposal Approval Form"
}, {
    "value": "crm_proposal_form",
    "label": "Proposal Form"
}, {
    "value": "crm_proposal_resubmit_form",
    "label": "Proposal Resubmit Form"
}, {
    "value": "crm_proposal_sending_form",
    "label": "Proposal Sending Form"
}]

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

Description
Deploy a new version of XPDL to an app

...

- 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

Code Block

language	js

{"status" : "complete"}

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

Description
Retrieves XPDL file of an app

...

- 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

...

- 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

Code Block

language	js

{
    "total": 2,
    "data": [{
        "id": "org.joget.apps.app.lib.EmailTool",
        "pluginName": "Email Tool",
        "pluginDescription": "Sends email message to targeted recipient(s)"
    }, {
        "id": "org.joget.apps.app.lib.ProcessDataCollectorAuditTrail",
        "pluginName": "Process Data Collector",
        "pluginDescription": "Save process data into app_report_* tables for reporting purposes"
    }]
}

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

Description
Retrieves all created custom i18n message of an app

...

- 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

Code Block

language	js

{
    "total": 1,
    "data": {
        "message": "查询",
        "id": "general.method.label.search_zh_CN",
        "locale": "zh_CN",
        "messageKey": "general.method.label.search"
    }
}

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

Description
Retrieves all userviews of an app

...

- 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

Code Block

language	js

{
    "total": 1,
    "data": {
        "id": "crm_userview_sales",
        "dateModified": "13-09-2015 02:55 AM",
        "description": "",
        "name": "CRM: Sales Force Automation",
        "dateCreated": "22-07-2015 11:24 PM"
    }
}

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

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

...

- 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

Code Block

language	js

[{
    "value": "",
    "label": ""
}, {
    "value": "crm_userview_sales",
    "label": "CRM: Sales Force Automation"
}]

web/json/workflow/package/list

Description
Retrieves package (app) list

User Role

Admin

URL
/web/json/workflow/package/list

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

Code Block

language	js

{
    "data": [{
        "packageId": "crm",
        "packageName": "CRM"
    }, {
        "packageId": "helpdesk",
        "packageName": "Helpdesk"
    }]
}

...

- 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

Code Block

language	js

{
    "assignment" : "879_223_crm_process1_approve_proposal"
    "status" : "accepted"
}

...

- 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

Code Block

language	js

{
    "activityId": "879_223_crm_process1_approve_proposal",
    "nextActivityId": "882_223_crm_process1_send_proposal",
    "processId": "223_crm_process1",
    "status": "completed"
}

...

- 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/complete/879_223_crm_process1_approve_proposal?var_status=Sent

Sample Result

Code Block

language	js

{
    "activityId": "879_223_crm_process1_approve_proposal",
    "nextActivityId": "882_223_crm_process1_send_proposal",
    "processId": "223_crm_process1",
    "status": "completed"
}

...

- 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

Code Block

language	js

{
    "total": 10,
    "data": [{
        "id": "477_118_crm_process1_approve_proposal",
        "activityId": "477_118_crm_process1_approve_proposal",
        "processVersion": "1",
        "serviceLevelMonitor": "-",
        "processId": "118_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "21-07-2015 03:03 AM",
        "label": "Approve Proposal",
        "acceptedStatus": false,
        "activityName": "Approve Proposal"
    }, {
        "id": "479_119_crm_process1_approve_proposal",
        "activityId": "479_119_crm_process1_approve_proposal",
        "processVersion": "1",
        "serviceLevelMonitor": "-",
        "processId": "119_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "21-07-2015 03:03 AM",
        "label": "Approve Proposal",
        "acceptedStatus": false,
        "activityName": "Approve Proposal"
    }, {
        "id": "481_120_crm_process1_approve_proposal",
        "activityId": "481_120_crm_process1_approve_proposal",
        "processVersion": "1",
        "serviceLevelMonitor": "-",
        "processId": "120_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "21-07-2015 03:03 AM",
        "label": "Approve Proposal",
        "acceptedStatus": false,
        "activityName": "Approve Proposal"
    }]
}

web/json/workflow/assignment/list/count

Description
Retrieves the number of assignments of current logged in user

...

- 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

Code Block

language	js

{"total":10}

web/json/workflow/assignment/list/accepted

Description
Retrieves all accepted assignments of current logged in user

...

Code Block

language	js

{
    "total": 10,
    "data": [{
        "id": "477_118_crm_process1_approve_proposal",
        "activityId": "477_118_crm_process1_approve_proposal",
        "processVersion": "1",
        "serviceLevelMonitor": "-",
        "processId": "118_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "21-07-2015 03:03 AM",
        "label": "Approve Proposal",
        "acceptedStatus": false,
        "activityName": "Approve Proposal"
    }, {
        "id": "479_119_crm_process1_approve_proposal",
        "activityId": "479_119_crm_process1_approve_proposal",
        "processVersion": "1",
        "serviceLevelMonitor": "-",
        "processId": "119_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "21-07-2015 03:03 AM",
        "label": "Approve Proposal",
        "acceptedStatus": false,
        "activityName": "Approve Proposal"
    }, {
        "id": "481_120_crm_process1_approve_proposal",
        "activityId": "481_120_crm_process1_approve_proposal",
        "processVersion": "1",
        "serviceLevelMonitor": "-",
        "processId": "120_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "21-07-2015 03:03 AM",
        "label": "Approve Proposal",
        "acceptedStatus": false,
        "activityName": "Approve Proposal"
    }]
}

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

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

...

- 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

Code Block

language	js

{"total":3}

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

Description

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

...

- 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

Code Block

language	js

{
    "data": [{
        "count": 3,
        "processVersion": "3",
        "processName": "Proposal Approval Process",
        "processDefId": "crm#3#process1",
        "label": "Proposal Approval Process ver 3 (3)",
        "url": "/json/workflow/assignment/list/accepted?processId=crm%233%23process1"
    }]
}

web/json/workflow/assignment/list/pending

Description
Retrieves all pending assignments of current logged in user

...

- 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

Code Block

language	js

{
    "total": 3,
    "data": [{
        "id": "841_206_crm_process1_send_proposal",
        "activityId": "841_206_crm_process1_send_proposal",
        "processVersion": "3",
        "serviceLevelMonitor": "-",
        "processId": "206_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "04-09-2015 11:05 AM",
        "label": "Send Proposal",
        "activityName": "Send Proposal"
    }, {
        "id": "842_207_crm_process1_approve_proposal",
        "activityId": "842_207_crm_process1_approve_proposal",
        "processVersion": "3",
        "serviceLevelMonitor": "-",
        "processId": "207_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "04-09-2015 11:05 AM",
        "label": "Approve Proposal",
        "activityName": "Approve Proposal"
    }, {
        "id": "843_208_crm_process1_send_proposal",
        "activityId": "843_208_crm_process1_send_proposal",
        "processVersion": "3",
        "serviceLevelMonitor": "-",
        "processId": "208_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "04-09-2015 11:05 AM",
        "label": "Send Proposal",
        "activityName": "Send Proposal"
    }]
}

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

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

...

- 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

Code Block

language	js

{"total":3}

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

Description
Retrieve first process with details of every packagesRetrieves process list based on pending assignments of current logged in user

User Role

Admin

Anyone (Including anonymous)

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/processassignment/list/packagepending/process

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

Code Block

language	js

{
    "data": [{
        "count": 3,
        "processVersion": "3",
        "processName": "Proposal Approval Process",
        "processDefId": "crm#3#process1",
        "label": "Proposal Approval Process ver 3 (3)",
        "url": "/json/workflow/assignment/list/accepted?processId=crm%233%23process1"
    }]
}

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
- checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

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

Code Block

language	js

{
    "activityId": "843_208_crm_process1_send_proposal",
    "processVersion": "3",
    "activityDefId": "send_proposal",
    "processId": "208_crm_process1",
    "assigneeId": "admin",
    "description": "",
    "processName": "Proposal Approval Process",
    "dateCreated": "04-09-2015 03:05 AM",
    "participant": "Requester",
    "processDefId": "crm#3#process1",
    "variable": {
        "status": "approved"
    },
    "activityName": "Send Proposal"
}

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

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/jw/web/json/workflow/process/list/package

Sample Result

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

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/jw/web/json/workflow/process/list/package

Sample Result

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

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/jw/web/json/workflow/process/list/package

Sample Result

Processes

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

...

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 Result

web/json/workflow/process/list

Description
Retrieves process list

User Role

Admin

URL
/web/json/workflow/process/list

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 Result

Code Block

language	js

{
    "total": 3,
    "desc": false,
    "sort": "name",
    "start": 0,
    "data": [{
        "id": "hdc_v1001#1#hdc_certification_process",
        "packageName": "halal certification",
        "name": "HDC Certification Process",
        "packageId": "hdc_v1001",
        "label": "HDC Certification Process ver 1",
        "version": "1"
    }, {
        "id": "mdec_v1002#12#mdec_wp1",
        "packageName": "Mdec Work Progress",
        "name": "mdec_wp1",
        "packageId": "mdec_v1002",
        "label": "mdec_wp1 ver 12",
        "version": "12"
    }, {
        "id": "mora#5#mora_new_application",
        "packageName": "MORA Halal Certification",
        "name": "MORA New Application",
        "packageId": "mora",
        "label": "MORA New Application ver 5",
        "version": "5"
    }]
}

...

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/jw/web/json/workflow/process/list/package

Sample Result

Code Block

{
    "data": [{
        "id": "mora",
        "count": 1,
        "processVersion": "5",
        "packageName": "MORA Halal Certification",
        "processId": "mora#5#mora_new_application",
        "processName": "MORA New Application",
        "packageId": "mora",
        "label": "MORA Halal Certification",
        "url": "/json/workflow/process/list?packageId=mora"
    }, {
        "id": "mdec_v1002",
        "count": 1,
        "processVersion": "12",
        "packageName": "Mdec Work Progress",
        "processId": "mdec_v1002#12#mdec_wp1",
        "processName": "mdec_wp1",
        "packageId": "mdec_v1002",
        "label": "Mdec Work Progress",
        "url": "/json/workflow/process/list?packageId=mdec_v1002"
    }, {
        "id": "hdc_v1001",
        "count": 1,
        "processVersion": "1",
        "packageName": "halal certification",
        "processId": "hdc_v1001#1#hdc_certification_process",
        "processName": "HDC Certification Process",
        "packageId": "hdc_v1001",
        "label": "halal certification",
        "url": "/json/workflow/process/list?packageId=hdc_v1001"
    }]
}

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

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/jw/web/json/workflow/process/list/package

Sample Result

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

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/jw/web/json/workflow/process/list/package

Sample Result

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

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/jw/web/json/workflow/process/list/package

Sample Result

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

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/jw/web/json/workflow/process/list/package

Sample Result

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

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/jw/web/json/workflow/process/list/package

...

- 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

Code Block

language	js

{
    "total": 3225,
    "data": [{
        "timestamp": "25-06-2015 07:41 AM",
        "message": "Authentication for user admin: true",
        "id": "2c90a1574e29523a014e29aa77590000",
        "username": "anonymousUser",
        "method": "authenticate",
        "clazz": "org.joget.apps.workflow.security.WorkflowAuthenticationProvider"
    }, {
        "timestamp": "25-06-2015 08:41 AM",
        "message": "Authentication for user admin: true",
        "id": "2c90a1574e29e104014e29e178080000",
        "username": "anonymousUser",
        "method": "authenticate",
        "clazz": "org.joget.apps.workflow.security.WorkflowAuthenticationProvider"
    }, {
        "timestamp": "25-06-2015 08:55 AM",
        "message": "testProcess",
        "id": "2c90a1574e29e81c014e29eddb7a0000",
        "username": "admin",
        "method": "processUpload",
        "clazz": "org.joget.workflow.model.service.WorkflowManagerImpl"
    }, {
        "timestamp": "25-06-2015 08:55 AM",
        "message": "50_testProcess_process1",
        "id": "2c90a1574e29e81c014e29eddecf0001",
        "username": "anonymousUser",
        "method": "processCompleted",
        "clazz": "org.joget.workflow.model.service.WorkflowManagerImpl"
    }, {
        "timestamp": "25-06-2015 08:55 AM",
        "message": "50_testProcess_process1",
        "id": "2c90a1574e29e81c014e29edded80002",
        "username": "anonymousUser",
        "method": "processCompleted",
        "clazz": "org.joget.workflow.model.service.WorkflowManagerImpl"
    }]
}

...

- 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

Code Block

language	js

{
    "total": 7,
    "data": [{
        "id": "D-001",
        "description": "",
        "name": "CEO Office",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }, {
        "id": "D-002",
        "description": "",
        "name": "Human Resource and Admin",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }, {
        "id": "D-003",
        "description": "",
        "name": "Finance",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }, {
        "id": "D-004",
        "description": "",
        "name": "Marketing",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }, {
        "id": "D-005",
        "description": "",
        "name": "Product Development",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }, {
        "id": "D-006",
        "description": "",
        "name": "Training and Consulting",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }, {
        "id": "D-007",
        "description": "",
        "name": "Support and Services",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }]
}

...

- 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

Code Block

language	js

{
    "total": 2,
    "data": [{
        "grade.name": "Managers",
        "user.firstName": "Jack",
        "user.id": "jack",
        "role": null,
        "user.lastName": "Drake",
        "organization.name": "Joget.Org",
        "employeeCode": null,
        "user.username": "jack",
        "department.name": "Training and Consulting"
    }, {
        "grade.name": "Executives",
        "user.firstName": "Julia",
        "user.id": "julia",
        "role": null,
        "user.lastName": "Kapatelis",
        "organization.name": "Joget.Org",
        "employeeCode": null,
        "user.username": "julia",
        "department.name": "Human Resource and Admin"
    }]
}

...

- 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

Code Block

language	js

{
    "total": 1,
    "data": {
        "user.firstName": "Admin",
        "user.id": "admin",
        "role": "",
        "user.lastName": "",
        "employeeCode": "",
        "user.username": "admin"
    }
}

...

- 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

Code Block

language	js

{
    "total": 3,
    "data": [{
        "grade.name": "Executives",
        "user.firstName": "Cat",
        "user.id": "cat",
        "role": "",
        "user.lastName": "Grant",
        "employeeCode": "",
        "user.username": "cat",
        "department.name": "Product Development"
    }, {
        "grade.name": "Managers",
        "user.firstName": "Jack",
        "user.id": "jack",
        "role": null,
        "user.lastName": "Drake",
        "employeeCode": null,
        "user.username": "jack",
        "department.name": "Training and Consulting"
    }, {
        "grade.name": "Executives",
        "user.firstName": "Julia",
        "user.id": "julia",
        "role": null,
        "user.lastName": "Kapatelis",
        "employeeCode": null,
        "user.username": "julia",
        "department.name": "Human Resource and Admin"
    }]
}

...

- 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

Code Block

language	js

{
    "total": 3,
    "data": [{
        "grade.name": "Managers",
        "user.firstName": "Clark",
        "user.id": "clark",
        "role": null,
        "user.lastName": "Kent",
        "employeeCode": null,
        "user.username": "clark",
        "department.name": "Product Development"
    }, {
        "grade.name": "Managers",
        "user.firstName": "Jack",
        "user.id": "jack",
        "role": null,
        "user.lastName": "Drake",
        "employeeCode": null,
        "user.username": "jack",
        "department.name": "Training and Consulting"
    }, {
        "grade.name": "Managers",
        "user.firstName": "David",
        "user.id": "david",
        "role": null,
        "user.lastName": "Cain",
        "employeeCode": null,
        "user.username": "david",
        "department.name": "Support and Services"
    }]
}

...

- 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

Code Block

language	js

{
    "total": 3,
    "data": [{
        "id": "G-001",
        "description": "",
        "name": "Managers",
        "organization.name": ""
    }, {
        "id": "G-002",
        "description": "",
        "name": "CxO",
        "organization.name": ""
    }, {
        "id": "G-003",
        "description": "",
        "name": "hrAdmin",
        "organization.name": ""
    }]
}

...

- 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

Code Block

language	js

{
    "total": 3,
    "data": [{
        "id": "G-001",
        "description": "",
        "name": "Board Members"
    }, {
        "id": "G-002",
        "description": "",
        "name": "Managers"
    }, {
        "id": "G-003",
        "description": "",
        "name": "Executives"
    }]
}

...

- 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

Code Block

language	js

{
    "total": 1,
    "data": {
        "id": "ORG-001",
        "description": "",
        "name": "Joget.Org"
    }
}

...

- 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

Code Block

language	js

{
    "total": 1,
    "data": {
        "id": "sub",
        "description": "",
        "name": "Sub Department"
    }
}

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

Description
Retrieves all departments and grades in an organization

...

- 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

Code Block

language	js

{
    "departments": [{
        "id": "",
        "name": "",
        "prefix": ""
    }, {
        "id": "D-001",
        "prefix": "",
        "name": "CEO Office"
    }, {
        "id": "D-003",
        "prefix": "",
        "name": "Finance"
    }, {
        "id": "D-002",
        "prefix": "",
        "name": "Human Resource and Admin"
    }, {
        "id": "D-004",
        "prefix": "",
        "name": "Marketing"
    }, {
        "id": "D-005",
        "prefix": "",
        "name": "Product Development"
    }, {
        "id": "D-007",
        "prefix": "",
        "name": "Support and Services"
    }, {
        "id": "D-006",
        "prefix": "",
        "name": "Training and Consulting"
    }],
    "grades": [{
        "id": "",
        "name": "",
        "prefix": ""
    }, {
        "id": "G-001",
        "name": "Board Members"
    }, {
        "id": "G-003",
        "name": "Executives"
    }, {
        "id": "G-002",
        "name": "Managers"
    }]
}

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

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

...

- 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

Code Block

language	js

{
    "total": 1,
    "data": {
        "id": "G-001",
        "description": "",
        "name": "Managers",
        "organization.name": ""
    }
}

...

- 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

Code Block

language	js

{
    "total": 1,
    "data": {
        "id": "terry",
        "lastName": "Berg",
        "username": "terry",
        "email": "",
        "active": "Active",
        "firstName": "Terry"
    }
}

...

- 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

Code Block

language	js

{
    "total": 4,
    "data": [{
        "id": "admin",
        "lastName": "",
        "username": "admin",
        "email": "",
        "firstName": "Admin"
    }, {
        "id": "cat",
        "lastName": "Grant",
        "username": "cat",
        "email": "owen@joget.org",
        "firstName": "Cat"
    }, {
        "id": "clark",
        "lastName": "Kent",
        "username": "clark",
        "email": "",
        "firstName": "Clark"
    }, {
        "id": "david",
        "lastName": "Cain",
        "username": "david",
        "email": "",
        "firstName": "David"
    }]
}

...

- 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

Code Block

language	js

{"username":"admin","isAdmin":"true"}

...

- 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

Code Block

language	js

{"username":"admin"}

...

- className - (Optional) class name of plugin type abstract class or interface
- start - where rows start from
- rows - number of rows per page

Sample URL

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

Sample Result

Code Block

language	js

{
    "total": 140,
    "start": 0,
    "data": [{
        "id": "org.joget.plugin.enterprise.AjaxSubForm",
        "description": "AJAX Subform Element",
        "name": "AJAX Subform",
        "version": "5.0.0"
    }, {
        "id": "org.joget.plugin.enterprise.AdminUserviewPermission",
        "description": "",
        "name": "Is Admin",
        "version": "5.0.0"
    }, {
        "id": "org.joget.plugin.enterprise.AdvancedFormRowDataListBinder",
        "description": "Retrieves data rows from a form table.",
        "name": "Advanced Form Data Binder",
        "version": "5.0.0"
    }, {
        "id": "org.joget.plugin.enterprise.AdvancedGrid",
        "description": "Advanced Grid Element",
        "name": "Advanced Grid",
        "version": "5.0.0"
    }, {
        "id": "org.joget.plugin.enterprise.AnonymousUserviewPermission",
        "description": "",
        "name": "Is Anonymous",
        "version": "5.0.0"
    }]
}

...

- className - (Optional) class name of plugin type abstract class or interface
- start - where rows start from
- rows - number of rows per page

Sample URL

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

Sample Result

Code Block

language	js

{
    "total": 1,
    "start": 0,
    "data": {
        "id": "test.directory.TestDirectoryManager",
        "description": "Test Directory Manager",
        "name": "Test Directory Manager",
        "version": "1.0.0"
    }
}

...

Parameters

- classname - class name of of plugin type abstract class or interface

Sample URL

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

Sample Result

Code Block

language	js

[{
    "value": "",
    "label": ""
}, {
    "value": "org.joget.apps.app.lib.DatabaseUpdateTool",
    "label": "Database Update Tool"
}, {
    "value": "org.joget.apps.app.lib.EmailTool",
    "label": "Email Tool"
}, {
    "value": "org.joget.apps.app.lib.JsonTool",
    "label": "Json Tool"
}]

...

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

Code Block

language	js

[{
    title: 'Configure Bean Shell',
    properties: [{
        name: 'script',
        label: 'Script',
        type: 'codeeditor',
        required: 'True',
        mode: 'java'
    }]
}]

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

Description
Retrieves the default 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

Code Block

language	js

{
    "host": "smtp.gmail.com",
    "port": "456",
    "security": "SSL",
    "username": "test@gmail.com",
    "password": "test",
    "from": "test@gmail.com",
    "toSpecific": "",
    "toParticipantId": "",
    "cc": "",
    "bcc": "",
    "subject": "",
    "message": "",
    "isHtml": "",
    "formDefId": "",
    "fields": [],
    "files": []
}

...

Description
Retrieves the Plugin Properties Options of 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

Code Block

language	js

[{
    title: 'Configure Bean Shell',
    properties: [{
        name: 'script',
        label: 'Script',
        type: 'codeeditor',
        required: 'True',
        mode: 'java'
    }]
}]

...

- 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

...

- 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

Code Block

language	js

{"total":1,"data":{"message":"搜索","id":"402880824fb19a77014fb5025ed80002","locale":"zh_CN","key":"general.method.label.search"}}

...

Method
HTTP GET/POST

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

Sample Result

Code Block

language	js

["assignment.activityDefId", "assignment.activityId", "assignment.activityName", "assignment.assigneeId", "assignment.processDefId", "assignment.processId", 
"assignment.processName", "assignment.processRequesterId", "assignment.processVersion", "currentUser.active", "currentUser.email", "currentUser.firstName", 
"currentUser.lastName", "currentUser.timeZone", "currentUser.username", "date.DAY+INTEGER.FORMAT", "date.DAY-INTEGER.FORMAT", "date.FORMAT", "date.MONTH+INTEGER.FORMAT", 
"date.MONTH-INTEGER.FORMAT", "date.YEAR+INTEGER.FORMAT", "date.YEAR-INTEGER.FORMAT", "envVariable.KEY", "form.TABLE.COLUMN", "form.TABLE.COLUMN[PRIMARY_KEY]", "i18n.KEY", 
"performer.ACTIVITY_DEF_ID.active", "performer.ACTIVITY_DEF_ID.email", "performer.ACTIVITY_DEF_ID.firstName", "performer.ACTIVITY_DEF_ID.id", "performer.ACTIVITY_DEF_ID.lastName", 
"performer.ACTIVITY_DEF_ID.timeZone", "performer.ACTIVITY_DEF_ID.username", "request.characterEncoding", "request.contextPath", "request.header.NAME", "request.locale", 
"request.method", "request.pathInfo", "request.protocol", "request.queryString", "request.remoteAddr", "request.requestURI", "request.requestURL", "request.requestedSessionId", 
"request.scheme", "request.serverName", "request.serverPort", "request.servletPath", "requestParam.KEY", "user.USERNAME.active", "user.USERNAME.email", "user.USERNAME.firstName", 
"user.USERNAME.lastName", "user.USERNAME.timeZone", "variable.KEY"]

...

- 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

Code Block

language	js

{"success":true,"datasource":"default"}

...

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 17

New Version 18

Key

Table of Contents

App

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

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

web/json/apps/install

web/json/apps/published/processes

web/json/apps/published/userviews

web/json/console/app/list

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

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

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

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

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

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

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

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

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

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

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

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

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

web/json/workflow/package/list

web/json/workflow/assignment/list/count

web/json/workflow/assignment/list/accepted

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

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

web/json/workflow/assignment/list/pending

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

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

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

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

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

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

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

Processes

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

web/json/workflow/process/list

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

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

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

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

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

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

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

web/json/console/setting/message/list

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

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

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

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