在 v5中引入, 需要配置“ 常规设置”中的“API域白名单”设置以允许JSON API请求。 如果请求来自非白名单域，则响应将是HTTP 400错误请求。

Form Data API和List Data API是Joget Workflow v6中的新增功能。


应用

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

说明 
检索表单的所有列

用户角色

Admin

方法 
HTTP GET/POST

参数

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

示例结果

[{
    "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

说明 
基于表单执行生成器插件

用户角色

Admin

方法

HTTP POST

参数

示例 URL

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

示例 结果

{
    "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

说明
从URL下载并导入应用程序

用户角色

Admin

  方法

HTTP POST

  参数

示例URL

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

示例结果

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

web/json/apps/published/processes

说明
根据登录用户检索所有已发布的进程

用户角色

任何人（包括匿名）

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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

说明
根据登录用户检索所有发布的用户视图

用户角色 

任何人（包括匿名）

Method

HTTP GET/POST

参数

示例URL 

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

示例结果 

{
    "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

说明
检索所有应用程序

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

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

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

说明
检索应用程序的所有版本

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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  

说明
检索所有Datalist Actions插件

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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',         说明: 'URL (Eg. http:\\/\\/www.google.com)'     },     {         label : 'Hyperlink Target',         name : 'target',         type : 'selectbox',         说明: '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 : '参数',         label : 'Hyperlink 参数',         type : 'gridCombine',         columns : [{             key : 'hrefParam',             label : 'Parameter Name'         },         {             key : 'hrefColumn',             label : 'Column Name'         }]     },     {         label : 'Label',         name : 'label',         type : 'textfield',         说明: '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:''             }         ]     }] }]"
    }]
}

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

说明
检索应用程序的所有环境变量

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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

说明
检索应用程序的所有数据列表

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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

说明
检索一个应用中所有带有value-lable 标签的数据列表

用户角色

Admin

方法

HTTP GET/POST

参数

示例URL

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

示例结果

[{
    "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

说明
检索应用程序中使用的所有表名称

用户角色

Admin

方法

HTTP GET/POST

参数

示例URL

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

示例结果

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

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

说明
检索应用程序中的所有表单

用户角色

Admin

方法

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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

说明
检索应用中所有带value-lable的表单

用户角色

Admin

方法

HTTP GET/POST

参数

示例URL

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

示例结果

[{
    "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

说明
将新版本的XPDL部署到应用程序

用户角色

Admin

方法

HTTP POST

参数

示例URL

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

示例结果

{"status" : "complete"}

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

说明
检索应用程序的XPDL文件

用户角色

Admin

方法

HTTP GET/POST

参数

示例URL

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

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

说明
检索应用程序中所有已配置默认属性的插件

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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

说明
检索应用程序的所有已创建的自定义i18n消息

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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

说明
检索应用程序的所有用户视图

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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

说明
检索应用程序中所有带value-lable标签的userview

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

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

web/json/workflow/package/list

说明
检索package（app）列表

用户角色

Admin

方法
HTTP GET/POST

参数

示例URL

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

示例结果 

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

分配

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

说明
接受已分配的作业

弃用  自v3以来，接受和撤销分配的概念被删除  

用户角色

任何人（包括匿名）

方法

HTTP POST

参数

示例URL

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

示例结果

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

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

说明
完成已分配的分配

用户角色

任何人（包括匿名）

方法

HTTP POST

参数

示例URL

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

示例结果

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

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

说明
使用选项设置工作流变量完成分配的分配。

用户角色

任何人（包括匿名）

方法

HTTP POST

参数

示例URL

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

示例结果

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

web/json/workflow/assignment/list

说明
检索当前登录用户的所有分配

用户角色

任何人（包括匿名）

方法

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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

说明
检索当前登录用户的分配数量

用户角色

任何人（包括匿名）

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{"total":10}

web/json/workflow/assignment/list/accepted

说明
检索当前登录用户的所有接受的分配

弃用  自v3以来，接受和撤销分配的概念被删除  

用户角色

任何人（包括匿名）

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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  

说明
检索当前登录用户的接受分配数量

弃用  自v3以来，接受和撤销分配的概念被删除  

用户角色

任何人（包括匿名）

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{"total":3}

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

说明

根据当前登录用户接受的分配检索进程列表

弃用  自v3以来，接受和撤销分配的概念被删除  

用户角色 

任何人（包括匿名）

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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

说明
检索当前登录用户的所有未决分配 

用户角色 

任何人（包括匿名）  

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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

说明
检索当前登录用户的所有未决分配的数量 

用户角色

任何人（包括匿名）  

方法

HTTP GET/POST

参数

示例URL 

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

示例结果

{"total":3}

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

说明
根据当前登录用户的未决分配来检索进程列表

用户角色

任何人（包括匿名）

Method

HTTP GET/POST

参数

示例URL 

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

示例结果

{
    "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)

说明
根据当前登录用户的可用分配来检索进程信息

用户角色

任何人（包括匿名）

方法

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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)

说明
撤销接受的作业

弃用  自v3以来，接受和撤销分配的概念被删除  

用户角色

任何人（包括匿名）

Method

HTTP POST

参数

示例URL 

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

示例结果

{
    "activityId": "879_223_crm_process1_approve_proposal",
    "status": "withdrawn"
}

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

说明
设置分配的工作流程变量的值

用户角色

任何人（包括匿名）

Method

HTTP POST

参数

示例URL 

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

示例结果

{"status":"variableSet"}

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

说明
检索assignment的信息

用户角色

任何人（包括匿名）

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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"
}

Processes

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

说明
Aborts a running process instance

用户角色

Admin

方法
HTTP POST

参数

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

示例结果

{"status":"aborted","processId":"208_crm_process1"}

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

说明
Gets latest Process def Id of a process based on a Process def Id

用户角色

Admin

方法
HTTP GET/POST

参数

示例URL

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

示例结果

{"id":"crm#3#process1","encodedId":"crm:3:process1"}

web/json/workflow/process/list

说明
Retrieves process list

用户角色

Admin

方法
HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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"
    }]
}

web/json/workflow/process/list/package

说明
Retrieve first process with details of every packages

用户角色

Admin

方法
HTTP GET/POST

参数

示例URL
http:/localhost:8080/jw/web/json/workflow/process/list/package

示例结果

 

{
    "data": [{
        "id": "hr_expense",
        "count": 2,
        "processVersion": "3",
        "packageName": "HR Expenses Claim App",
        "processId": "hr_expense#3#process1",
        "processName": "Expense Approval Process",
        "packageId": "hr_expense",
        "label": "HR Expenses Claim App",
        "url": "/json/workflow/process/list?packageId=hr_expense"
    }, {
        "id": "isr",
        "count": 1,
        "processVersion": "2",
        "packageName": "ISR",
        "processId": "isr#2#isr",
        "processName": "ISR Process",
        "packageId": "isr",
        "label": "ISR",
        "url": "/json/workflow/process/list?packageId=isr"
    }, {
        "id": "hrleave",
        "count": 2,
        "processVersion": "1",
        "packageName": "JINC Leave Solution",
        "processId": "hrleave#1#la",
        "processName": "Leave Application System",
        "packageId": "hrleave",
        "label": "JINC Leave Solution",
        "url": "/json/workflow/process/list?packageId=hrleave"
    }]
}

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

说明
Starts a process based on process start whitelist

用户角色

任何人（包括匿名）  

Method

HTTP POST

参数

示例URL

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

示例结果

{"activityId":"885_224_crm_process1_approve_proposal","processId":"224_crm_process1"}

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

说明
Sets workflow variable of a process instance

用户角色

Admin

Method

HTTP POST

参数

示例URL

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

示例结果

{"status" : "variableSet"}

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

说明
Retrieves information of a process definition

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "packageName": "CRM",
    "processId": "crm#3#process1",
    "name": "Proposal Approval Process",
    "packageId": "crm",
    "version": "3"
}

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

说明
Retrieves all variables of a process instance

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "processId": "208_crm_process1",
    "variable": {
        "status": "approved"
    }
}

 

Monitoring

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

说明
Aborts an activity of a process instance

用户角色

Admin

Method

HTTP POST

参数

示例URL

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

示例结果

{"activityDefId":"send_proposal","status":"aborted","processId":"208_crm_process1"}

web/json/monitoring/activity/list

说明
Retrieves a list of all activities

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "total": 3,
    "data": [{
        "id": "474_116_hr_expense_process1_approve_claim",
        "serviceLevelMonitor": "-",
        "name": "Approve Claim",
        "state": "open.not_running.not_started",
        "dateCreated": "15-07-2015 02:54 AM"
    }, {
        "id": "472_116_hr_expense_process1_new_claim",
        "serviceLevelMonitor": "-",
        "name": "Edit Claim",
        "state": "closed.completed",
        "dateCreated": "15-07-2015 02:53 AM"
    }, {
        "id": "473_116_hr_expense_process1_tool4",
        "serviceLevelMonitor": "-",
        "name": "Update Record Status to Submitted",
        "state": "closed.completed",
        "dateCreated": "15-07-2015 02:54 AM"
    }]
}

web/json/monitoring/activity/reassign

说明
Reassigns a user to replace another user assigned to an assignment

用户角色

Admin

Method

HTTP POST

参数

示例URL

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

示例结果

{"activityId":"841_206_crm_process1_send_proposal","username":"admin","replaceUser":"cat"}

web/json/monitoring/activity/reevaluate

说明
Reevaluates an activity

用户角色

Admin

Method

HTTP POST

参数

示例URL

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

 

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

说明
Starts an activity in a running process instance

用户角色

Admin

Method

HTTP POST

参数

示例URL

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

示例结果

{"result":true,"activityDefId":"verify_claim","processId":"116_hr_expense_process1"}

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

说明
Sets value to a workflow variable to a running activity instance

用户角色

Admin

Method

HTTP POST

参数

示例URL

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

示例结果

{"status":"variableSet"}

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

说明
Retrieves information of an activity instance

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "processId": "116_hr_expense_process1",
    "serviceLevelMonitor": "-",
    "createdTime": "Wed Jul 15 10:54:10 MYT 2015",
    "processName": "Expense Approval Process",
    "assignee": "admin",
    "activityId": "474_116_hr_expense_process1_approve_claim",
    "activityDefId": "approve_claim",
    "processVersion": "1",
    "processDefId": "hr_expense#1#process1",
    "participant": "approver",
    "finishTime": "",
    "variable": {
        "status": "test"
    },
    "activityName": "Approve Claim",
    "dueDate": ""
}

web/json/monitoring/completed/process/list

说明
Retrieves a list of all completed process instances

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "total": 74,
    "data": [{
        "id": "133_hr_expense_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Expense Approval Process",
        "state": "closed.aborted",
        "due": "-",
        "startedTime": "29-07-2015 01:46 AM",
        "version": "2"
    }, {
        "id": "135_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "closed.aborted",
        "due": "-",
        "startedTime": "04-08-2015 09:28 AM",
        "version": "2"
    }, {
        "id": "136_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "closed.aborted",
        "due": "-",
        "startedTime": "04-08-2015 09:31 AM",
        "version": "2"
    }]
}

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

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

用户角色

Admin

Method

HTTP POST

参数

示例URL

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

示例结果

{
    "processId": "228_hr_expense_process1",
    "processDefId": "hr_expense#1#process1",
    "activities": [ "896_228_hr_expense_process1_approve_claim" ]
}

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

说明
Sets a value to workflow variable of a process instance

用户角色

Admin

Method

HTTP POST

参数

示例URL

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

示例结果

{"status":"variableSet"}

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

说明
Retrieves information of a process instance

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "requester": "admin",
    "serviceLevelMonitor": "-",
    "processId": "224_crm_process1",
    "name": "Proposal Approval Process",
    "finishTime": "",
    "states": ["open.running", "open.running"],
    "packageId": "crm",
    "processDefId": "crm#3#process1",
    "dueDate": "",
    "startedTime": "",
    "version": "3"
}

web/json/monitoring/running/activity/complete

说明
Completes a running activity

用户角色

Admin

Method

HTTP POST

参数

示例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

说明
Reassigns a user to replace another user assigned to an assignment 

用户角色

Admin

Method

HTTP POST

参数

示例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

说明
Retrieves a list of all running process instances

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "total": 16,
    "data": [{
        "id": "118_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "open.running",
        "due": "-",
        "startedTime": "21-07-2015 03:03 AM",
        "version": "1"
    }, {
        "id": "119_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "open.running",
        "due": "-",
        "startedTime": "21-07-2015 03:03 AM",
        "version": "1"
    }, {
        "id": "120_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "open.running",
        "due": "-",
        "startedTime": "21-07-2015 03:03 AM",
        "version": "1"
    }]
}

web/json/monitoring/user/reevaluate

说明
Reevaluates all assignments of an user

用户角色

Admin

Method

HTTP POST

参数

示例URL

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

SLA

web/json/workflow/activity/sla/list

说明
Retrieve first process with details of every packages

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "total": 3,
    "data": [{
        "ratioOnTime": 100,
        "activityDefId": "approval",
        "serviceLevelMonitor": "<span class=\"dot_green\">&nbsp;<\/span>",
        "minDelay": 0,
        "ratioWithDelay": 0,
        "maxDelay": 0,
        "activityName": "Approval"
    }, {
        "ratioOnTime": 100,
        "activityDefId": "parallel",
        "serviceLevelMonitor": "<span class=\"dot_green\">&nbsp;<\/span>",
        "minDelay": 0,
        "ratioWithDelay": 0,
        "maxDelay": 0,
        "activityName": "Parallel"
    }, {
        "ratioOnTime": 100,
        "activityDefId": "route1",
        "serviceLevelMonitor": "<span class=\"dot_green\">&nbsp;<\/span>",
        "minDelay": 0,
        "ratioWithDelay": 0,
        "maxDelay": 0,
        "activityName": "Route 1"
    }]
}

Audit Trail

web/json/workflow/audittrail/list

说明
Retrieves a list of audit trail

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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"
    }]
}

Directory

web/json/directory/admin/dept/list

说明
Retrieves all department

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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": ""
    }]
}

web/json/directory/admin/employment/list

说明
Retrieves all user with employment details

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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"
    }]
}

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

说明
Retrieves all users not belong to any organization

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

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

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

说明
Retrieves all users not belong to a department

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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"
    }]
}

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

说明
Retrieves all users not belong to a grade

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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"
    }]
}

web/json/directory/admin/group/list

说明
Retrieves all groups

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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": ""
    }]
}

web/json/directory/admin/grade/list

说明
Retrieves all grades

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

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

web/json/directory/admin/organization/list

说明
Retrieves all organizations

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

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

web/json/directory/admin/subdept/list

说明
Retrieves all sub department of a department

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

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

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

说明
Retrieves all departments and grades in an organization

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果 

{
    "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

说明
Retrieves the groups that a user is in or not in.

用户角色 

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果 

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

web/json/directory/admin/user/list

说明
Retrieves a list of users

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

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

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

说明
Retrieves a list of user not in a group

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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"
    }]
}

web/json/directory/user/sso

说明
To single sign on a user

用户角色

Anonymous

Method

HTTP GET/POST, support HTTP basic authentication

参数

示例URL

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

示例结果

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

web/json/workflow/currentUsername

说明
Retrieves the username of current logged in user

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{"username":"admin"}

Plugin

web/json/plugin/list

说明
Retrieves a list of plugins

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果 

{
    "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"
    }]
}

web/json/plugin/listOsgi

说明
Retrieves a list of OSGI plugins

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果 

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

web/property/json/getElements

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

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

[{
    "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"
}]

web/property/json/getPropertyOptions

说明
Retrieves the 插件属性选项与配置 of a plugin

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果 

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

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

说明
Retrieves the default 插件属性选项与配置 of a plugin based on App Definition meta

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果

{
    "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": []
}

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

说明
Retrieves the 插件属性选项与配置 of a plugin with App Definition meta

用户角色

Admin

Method

HTTP GET/POST

参数

示例URL

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

示例结果 

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

System

web/json/apps/verify

说明
Verifies a URL is valid

用户角色

Admin

方法
HTTP HEAD

参数

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

web/json/console/setting/message/list

说明
Retrieves all messages added in 管理信息

用户角色

Admin

方法
HTTP GET/POST

参数

示例URL
http://localhost:8080/jw/web/json/console/setting/message/list

示例结果 

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

web/json/hash/options

说明
Retrieves all available Hash Variable syntax

用户角色

Admin

方法
HTTP GET/POST

示例URL
http://localhost:8080/jw/web/json/hash/options

示例结果 

["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"]

web/json/workflow/testConnection

说明
To tests a JDBC connection

用户角色

Admin

方法
HTTP GET/POST

参数

示例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=

示例结果 

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

Form Data API

web/json/data/form/load/(*:appId)/(*:formId)/(*:primaryKeyValue)

说明
Load a specific form record

用户角色

Admin

方法
HTTP GET/POST

参数

示例URL
http://localhost:8080/jw/web/json/data/form/load/crm/crm_account/001

Sample cURL Request

curl -v -d "j_username=admin&j_password=admin" "http://localhost:8080/jw/web/json/data/form/load/crm/crm_account/001?includeSubformData=true&includeReferenceElements=true&flatten=true"

Sample Response

{
    "country": "",
    "dateCreated": "27-07-2015 04:26 AM",
    "address": "",
    "accountName": "001",
    "city": "",
    "dateModified": "20-10-2016 04:36 AM",
    "id": "001",
    "state": ""
}


web/json/data/form/store/(*:appId)/(*:formId)/(*:primaryKeyValue)

说明
Create or update a form record

用户角色

Admin

方法
HTTP POST

参数

示例URL
http://localhost:8080/jw/web/json/data/form/store/crm/crm_account/001

Sample cURL Request

curl -v -X POST -d "j_username=admin&j_password=admin&accountName=001%Updated&address=001%20Address" http://localhost:8080/jw/web/json/data/form/store/crm//crm_account/001

or

curl -v --header "Authorization: Basic YWRtaW46YWRtaW4=" -F "accountName=001 Updated" -F "address=001 Address" http://localhost:8080/jw/web/json/data/form/store/crm//crm_account/001

Sample Response

{
    "id": "001"
}

web/json/data/form/delete/(*:appId)/(*:formId)/(*:primaryKeyValue)

说明
Delete an existing form record

用户角色

Admin

方法
HTTP POST

参数

示例URL
http://localhost:8080/jw/web/json/data/form/delete/crm/crm_account/001

Sample cURL Request

curl -v -X POST -d "j_username=admin&j_password=admin" http://localhost:8080/jw/web/json/data/form/delete/crm//crm_account/001

Sample Response

{
    "id": "001"
}

List Data API

web/json/data/list/(*:appId)/(*:listId)

说明
Load a specific form record

用户角色

Admin

方法
HTTP GET/POST

参数

示例URL
http://localhost:8080/jw/web/json/data/list/crm/crm_account_list

Sample cURL Request

curl -v -d "j_username=admin&j_password=admin" http://localhost:8080/jw/web/json/data/list/crm/crm_account_list?start=0&rows=20&d-5043735-fn_accountName=00

Sample Response

The returned attribute "total" will give the the total number of records regardless of the filters applied unless the attribute "Consider filter value when get total size?" is checked in the datalist.


{
    "total": 5,
    "data": [{
        "country": "",
        "accountName": "001 Updated",
        "id": "001",
        "state": ""
    }, {
        "country": "",
        "accountName": "002",
        "id": "002",
        "state": ""
    }, {
        "country": "",
        "accountName": "003",
        "id": "003",
        "state": ""
    }]
}

 

在v5中引入，需要配置“ 常规设置”中的“API域白名单”设置以允许JSON API请求。如果请求来自非白名单域，则响应将是HTTP 400错误请求。