Page History

...

应用

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

Description
Retrieves all columns for a form

说明 
检索表单的所有列

用户角色User Role

Admin

方法 Method
HTTP GET/POST

Parameters参数

• • appId appId - App definition id应用程序定义IDversion - (Optional) App definition version
  • 版本 - （可选）应用程序定义版本
  • formId - Form definition Id 表单定义ID 

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

Sample Result示例结果

[{
    "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（可选）调用此方法后调用的函数（在JavaScript中）
  • plugin - Class name of generator plugin to execute要执行的生成器插件的类名
  • appId - App Definition id应用程序定义IDversion
  • - (Optional) App definition version版本 - （可选）应用程序定义版本
  • formId - Form defintion id表单定义ID

Sample 示例 URL

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

Sample Result示例 结果

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

说明
从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
    
  • （可选）调用此方法后调用的函数（在JavaScript中）
  • 网址 - 网址下载一个应用程序
    

示例URL Sample URL

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

Sample Result示例结果

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

  web/json/apps/published/processes

Description
Retrieves all published processes based on logged in user

User Role

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

用户角色

任何人（包括匿名）Anyone (Including anonymous)

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • appId - (Optional) App definition Id to filter the list
  • （可选）调用此方法后调用的函数（在JavaScript中）
  • appId - （可选）应用定义ID来过滤列表

示例URLSample URL

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

Sample Result示例结果

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

User Role 

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

用户角色 

任何人（包括匿名）Anyone (Including anonymous)

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • appId -  (Optional) App definition Id to filter the list（可选）应用定义ID来过滤列表

示例URLSample URL 

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

Sample Result 示例结果 

{
    "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检索所有应用程序

用户角色User Role

Admin

Method

HTTP GET/POST

Parameters参数

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

  • sort - (Optional) column name to be sorted

  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)

  • start - (Optional) where rows start from

  • rows - (Optional) number of rows per page

  • （可选）调用此方法后调用的函数（在JavaScript中）
  • 名称 - （可选）名称过滤器

  • 排序 - （可选）要排序的列名称

  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • 开始 - （可选）行从哪里开始

  • 行 - （可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

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

用户角色User Role

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • appId - App Definition id应用程序定义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

  • 排序 - （可选）要排序的列名称

  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • 开始 - （可选）行从哪里开始

  • 行 - （可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

说明
检索所有Datalist Actions插件

用户角色User Role

Admin

Method

HTTP GET/POST

Parameters参数

• • appID - App Definition Id应用程序定义ID
  • version- (Optional) App Definition version（可选）应用程序定义版本

示例URLSample URL

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

Sample Result示例结果

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

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

Description
Retrieves all environment variable of an app

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

用户角色User Role

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • appId - App Definiton Id应用程序定义ID
  • version- (Optional) App Definiton version （可选）应用程序定义版本
  • filter - (Optional) id filter（可选）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)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

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

用户角色User Role

Admin

Method

HTTP GET/POST

Parameters

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

  • sort - (Optional) column name to be sorted

  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)

  • start - (Optional) where rows start from

  • rows - (Optional) number of rows per page

参数

• • callback  - （可选）调用此方法后调用的函数（在JavaScript中）
  • appId - 应用程序定义ID
  • version - （可选）应用程序定义版本
  • filter - （可选）名称过滤器

  • sort - （可选）要排序的列名称

  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - （可选）行从哪里开始

  • rows - （可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

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

用户角色User Role

Admin

Method方法

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this methodcallback  - （可选）调用此方法后调用的函数（在JavaScript中）
  • appId - App Defintion Id应用定义IDversion
  • - (optional) App Definiton versionversion - （可选）应用程序定义版本

  • 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)

    （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start -

    (Optional) where rows start from

  • rows - (Optional) number of rows per page

  • （可选）行从哪里开始

  • rows - （可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

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

用户角色User Role

Admin

Method方法

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • appId - App Definition Id应用程序定义ID
  • version - (Optional) App Definiton version（可选）应用程序定义版本

示例URLSample URL

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

Sample Result示例结果

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

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

Description
Retrieves all forms in an app

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

用户角色User Role

Admin

Method方法

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this methodcallback - （可选）调用此方法后调用的函数（在JavaScript中）
  • appId - App Definition id应用程序定义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

  • version - （可选）应用程序定义版本
  • name - （可选）名称过滤器

  • sort - （可选）要排序的列名称

  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - （可选）行从哪里开始

  • rows - （可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

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

用户角色User Role

Admin

Method方法

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • appId - App Definition id应用程序定义ID
  • version - (Optional) App Definition version（可选）应用程序定义版本

示例URLSample URL

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

Sample Result示例结果

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

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

用户角色User Role

Admin

Method方法

HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • appId - App Definition id  应用程序定义ID
  • version - (Optional) App Definition version（可选）应用程序定义版本
  • packageXpdl -  Multipart file of a XPDL fileXPDL文件的多部分文件

示例URLSample URL

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

Sample Result示例结果

{"status" : "complete"}

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

Description
Retrieves XPDL file of an app

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

用户角色User Role

Admin

Method方法

HTTP GET/POST

Parameters参数

• • appId - App Definition id应用程序定义ID
  • version - (Optional) App Definition version（可选）应用程序定义版本

示例URLSample URL

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

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

Description
Retrieves all configured default plugin properties of an app

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

用户角色User Role

Admin

Method

HTTP GET/POST

Parameters参数

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

  • sort - (Optional) column name to be sorted

  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)

  • start - (Optional) where rows start from

  • rows - (Optional) number of rows per page

  • - （可选）调用此方法后调用的函数（在JavaScript中）
  • appId - 应用程序定义ID
  • version - （可选）应用程序定义版本
  • filter - （可选）名称过滤器

  • sort - （可选）要排序的列名称

  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - （可选）行从哪里开始

  • rows -（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

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

用户角色User Role

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • appId - App Definition id应用程序定义ID
  • version - (Optional) App Definition version（可选）应用程序定义版本
  • filter - (Optional) id and message filter（可选）id和消息过滤器
  • 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)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

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

用户角色User Role

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • appId - App Definition id应用程序定义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)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

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

用户角色User Role

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • appId - App Definition id应用程序定义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

  • （可选）要排序的列名称

  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - （可选）行从哪里开始

  • rows -（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

web/json/workflow/package/list

Description
Retrieves package (app) list

说明
检索package（app）列表

用户角色 User Role

Admin

方法Method
HTTP GET/POST

Parameters参数

• • callback - a function (in JavaScript) to call back after invoking this method函数（在JavaScript中）在调用此方法后回调

示例URL Sample URL

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

Sample Result 示例结果

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

...

分配

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

Description
Accept an assigned assignment说明
接受已分配的作业

User Role

Anyone (Including anonymous)

用户角色

任何人（包括匿名）

方法Method

HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • activityId - Activity instance id 活动实例ID

示例URLSample URL

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

Sample Result示例结果

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

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

Description
Completes an assigned assignment

User Role

Anyone (Including anonymous)

说明
完成已分配的分配

用户角色

任何人（包括匿名）

方法Method

HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • activityId - activity instance id
  • （可选）调用此方法后调用的函数（在JavaScript中）
  • activityId - 活动实例ID

示例URLSample URL

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

Sample Result示例结果

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

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

User Role

Anyone (Including anonymous)

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

用户角色

任何人（包括匿名）

方法Method

HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • activityId - activity instance id活动实例ID
  • var_* - (Optional) parameters prefixed with "var_" used to set workflow variable（可选）用“var_”作为前缀的参数用于设置工作流程变量

示例URLSample URL

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

Sample Result示例结果

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

Description
Retrieves all assignments of current logged in user

User Role

Anyone (Including anonymous)

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

用户角色

任何人（包括匿名）

方法Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • packageId - (Optional) App Definition Id（可选）应用程序定义ID
  • processDefId - (Optional) Process definition Id with version（可选）具有版本的流程定义ID
  • processId - (Optional) Process instance id（可选）流程实例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

  • - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - （可选）行从哪里开始

  • rows -（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

User Role

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

用户角色

任何人（包括匿名）Anyone (Including anonymous)

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • packageId - (Optional) App Definition Id（可选）应用程序定义ID
  • processDefId - (Optional) Process definition Id with version（可选）具有版本的流程定义ID
  • processId - (Optional) Process instance id（可选）流程实例ID

示例URLSample URL

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

Sample Result示例结果

{"total":10}

web/json/workflow/assignment/list/accepted

Description
Retrieves all accepted assignments of current logged in user

User Role

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

用户角色

任何人（包括匿名）Anyone (Including anonymous)

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • processId - (Optional) Process instance id（可选）流程实例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)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

User Role

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

用户角色

任何人（包括匿名）Anyone (Including anonymous) 

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）

示例URLSample URL

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

Sample Result示例结果

{"total":3}

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

Description

Retrieves processes list based on accepted 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（可选）调用此方法后调用的函数（在JavaScript中）

示例URLSample URL

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

Sample Result示例结果

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

User Role 

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

用户角色 

任何人（包括匿名）  Anyone (Including anonymous)  

Method

HTTP GET/POST

Parameters参数

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

  • sort - (Optional) column name to be sorted

  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)

  • start - (Optional) where rows start from

  • rows - (Optional) number of rows per page

  • （可选）调用此方法后调用的函数（在JavaScript中）
  • processId -（可选）流程实例ID

  • sort - （可选）要排序的列名称

  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - （可选）行从哪里开始

  • rows -（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

User Role

Anyone (Including anonymous)  

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

用户角色

任何人（包括匿名）  

方法Method 

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）

示例URLSample URL 

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

Sample Result示例结果

{"total":3}

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

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

User Role

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

用户角色

任何人（包括匿名）Anyone (Including anonymous) 

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）

示例URLSample URL 

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

Sample Result示例结果

{
    "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（可选）调用此方法后调用的函数（在JavaScript中）
  • processId - Process instance id流程实例ID

示例URLSample URL

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

Sample Result示例结果

{
    "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
Withdraws an accepted assignment说明
撤销接受的作业

User Role

用户角色

任何人（包括匿名）Anyone (Including anonymous) 

Method

HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • activityId - activity instance id活动实例ID

示例URLSample URL 

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

Sample Result示例结果

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

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

Description
Sets value of workflow variable of an assignment

User Role

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

用户角色

任何人（包括匿名）Anyone (Including anonymous) 

Method

HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • activityId - activity instance id活动实例ID
  • variable - workflow variable to set value 工作流变量设置值
  • value - value of workflow variable工作流变量的值

示例URLSample URL 

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

Sample Result示例结果

{"status":"variableSet"}

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

Description
Retrieves information of an assignment

User Role

Anyone (Including anonymous) 

(*:activityId)  

说明
检索assignment的信息

用户角色

任何人（包括匿名）

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • activityId - activity instance id活动实例id

示例URLSample URL

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

Sample Result示例结果

{
    "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/process/abort/(*:processId)

说明Description
Aborts a running process instance

User Role用户角色

Admin

方法Method
HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • processId - Process instance id

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

Sample Result示例结果

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

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

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

User Role用户角色

Admin

方法Method
HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • processDefId - Process Definition Id (Replace '#' with ':' in the id)

Sample URL示例URL

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

Sample Result示例结果

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

web/json/workflow/process/list

说明Description
Retrieves process list

User Role用户角色

Admin

方法Method
HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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) package id (App id)
  • sort - （可选）要排序的列名称
  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）
  • start - （可选）行从哪里开始
  • rows -（可选）每页的行数rows - (Optional) number of rows per page
  • checkWhiteList - (Optional true/false) to return the list based on process white list

Sample URL示例URL

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

Sample Result示例结果

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

说明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（可选）调用此方法后调用的函数（在JavaScript中）
  • checkWhiteList - (Optional) Boolean value to return the list based on process white list

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

Sample Result示例结果

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

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

{"status" : "variableSet"}

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

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

...

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

说明Description
Aborts an activity of a process instance

User Role用户角色

Admin

Method

HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • processId - process instance id
  • activityDefId - activity definition id

Sample URL示例URL

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

Sample Result示例结果

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

web/json/monitoring/activity/list

说明Description
Retrieves a list of all activities

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • processId - (Optional) process instance id （可选）流程实例ID for filtering

  • sort - (Optional) column name to be sorted（可选）要排序的列名称

  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

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

User Role用户角色

Admin

Method

HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • username - username that will replace the assigned user
  • replaceUser - username of an existing assignee of the assignment
  • activityId - activity instance id 活动实例ID of the assignment

Sample URL示例URL

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

Sample Result示例结果

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

web/json/monitoring/activity/reevaluate

说明Description
Reevaluates an activity

User Role用户角色

Admin

Method

HTTP POST

Parameters参数

• • activityId - activity instance id 活动实例ID to be reevaluate

Sample URL示例URL

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

...

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

说明Description
Starts an activity in a running process instance

User Role用户角色

Admin

Method

HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • processId - process instance id
  • activityDefId - activity definition id
  • abortCurrent - (Optional) true of false value to abort all the running activities in the process instance

Sample URL示例URL

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

Sample Result示例结果

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

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

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

User Role用户角色

Admin

Method

HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • activityId - activity instance id
  • variable - workflow variable name
  • value - workflow variable value

Sample URL示例URL

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

Sample Result示例结果

{"status":"variableSet"}

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

说明Description
Retrieves information of an activity instance

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • activityId - activity instance id

Sample URL示例URL

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

Sample Result示例结果

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

说明Description
Retrieves a list of all completed process instances

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • packageId - (Optional) App/ package idpackage id
  • processId -（可选）流程实例ID processId - (Optional) process instance id for filtering
  • processName - (Optional) process name for filtering

  • sort - (Optional) column name to be sorted（可选）要排序的列名称

  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

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

User Role用户角色

Admin

Method

HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • processId - process instance id
  • processDefId - process definition id to start a new process (replace "#" to ":")
  • abortCurrent - (Optional) true or false value to abort the current running process instance after start a new process instance

Sample URL示例URL

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

Sample Result示例结果

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

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

User Role用户角色

Admin

Method

HTTP POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • processId - process instance id
  • variable - workflow variable name
  • value - workflow variable value

Sample URL示例URL

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

Sample Result示例结果

{"status":"variableSet"}

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

说明Description
Retrieves information of a process instance

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • processId - process instance id

Sample URL示例URL

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

Sample Result示例结果

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

说明Description
Completes a running activity

User Role用户角色

Admin

Method

HTTP POST

Parameters参数

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

Sample URL示例URL

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

web/json/monitoring/running/activity/reassign

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

User Role用户角色

Admin

Method

HTTP POST

Parameters参数

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

Sample URL示例URL

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

web/json/monitoring/running/process/list

说明Description
Retrieves a list of all running process instances

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • packageId - (Optional) app/package id
  • processId - (Optional) process instance id（可选）流程实例ID
  • processName - (Optional) process name
  • version - (Optional) process version

  • sort - (Optional) column name to be sorted（可选）要排序的列名称

  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

说明Description
Reevaluates all assignments of an user

User Role用户角色

Admin

Method

HTTP POST

Parameters参数

• • username - user to be reevaluate

Sample URL示例URL

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

...

web/json/workflow/activity/sla/list

说明Description
Retrieve first process with details of every packages

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • appId - (Optional) app defintion idappVersion - (Optional) app definition version
  • appversion - （可选）应用程序定义版本
  • processDefId - (Optional) process definition id without package id and version

Sample URL示例URL

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

Sample Result示例结果

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

...

web/json/workflow/audittrail/list

说明Description
Retrieves a list of audit trail

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • dateFrom - (Optional) date start for filtering. Format is yyyy-MM-dd
  • dateTo - (Optional) date to for filtering. Format is yyyy-MM-ddsort - (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

  • sort - （可选）要排序的列名称

  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - （可选）行从哪里开始

  • rows -（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

...

web/json/directory/admin/dept/list

说明Description
Retrieves all department

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

说明Description
Retrieves all user with employment details

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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

  • （可选）要排序的列名称

  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - （可选）行从哪里开始

  • rows -（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

说明Description
Retrieves all users not belong to any organization

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

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

说明Description
Retrieves all users not belong to a department

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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

  • （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - （可选）行从哪里开始

  • rows -（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

说明Description
Retrieves all users not belong to a grade

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

说明Description
Retrieves all groups

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • name - (Optional) name filter
  • orgId - (Optional) organization id for filter 

  • sort - (Optional) column name to be sorted

  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)

  • start - (Optional) where rows start from

  • rows - (Optional) number of rows per page

  • （可选）调用此方法后调用的函数（在JavaScript中）
  • name - （可选）名称过滤器
  • orgId - (Optional) organization id for filter 

  • sort - （可选）要排序的列名称

  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - （可选）行从哪里开始

  • rows -（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

说明Description
Retrieves all grades

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

说明Description
Retrieves all organizations

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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

  • （可选）名称过滤器

  • sort - （可选）要排序的列名称

  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - （可选）行从哪里开始

  • rows -（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

web/json/directory/admin/subdept/list

说明Description
Retrieves all sub department of a department

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • orgId - Organization id

Sample URL示例URL

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

Sample Result 示例结果 

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

User Role 用户角色 

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result 示例结果 

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

web/json/directory/admin/user/list

说明Description
Retrieves a list of users

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

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

说明Description
Retrieves a list of user not in a group

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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

  • sort - （可选）要排序的列名称

  • desc - （可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - （可选）行从哪里开始

  • rows -（可选）每页的行数

示例URLSample URL

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

Sample Result示例结果

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

说明Description
To single sign on a user

User Role用户角色

Anonymous

Method

HTTP GET/POST, support HTTP basic authentication

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • username - (Optional) username for login
  • password - (Optional) password for login
  • hash - (Optional) Hashed Password散列密码（Hashed Password）

示例URLSample URL

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

Sample Result示例结果

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

web/json/workflow/currentUsername

说明Description
Retrieves the username of current logged in user

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）

示例URLSample URL

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

Sample Result示例结果

{"username":"admin"}

Plugin

web/json/plugin/list

说明Description
Retrieves a list of plugins

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

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

Sample URL示例URL

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

Sample Result 示例结果 

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

说明Description
Retrieves a list of OSGI plugins

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • className - (Optional) class name of plugin type abstract class or interface 

  • start - where rows start from

  • rows - number of rows per page

Sample URL示例URL

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

Sample Result 示例结果 

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

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

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

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

Sample URL示例URL

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

Sample Result示例结果

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

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

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • value - Plugin class name

Sample URL示例URL

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

Sample Result 示例结果 

[{
    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 插件属性选项与配置 of a plugin based on App Definition meta

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • appId - App Definition Id应用程序定义ID
  • version - (Optional) App Defintion version
  • value - Plugin class name

Sample URL示例URL

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

Sample Result示例结果

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

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

User Role用户角色

Admin

Method

HTTP GET/POST

Parameters参数

• • appId appId - App Definition Id应用程序定义ID
  • version - (Optional) App Defintion version
  • value - Plugin class name

Sample URL示例URL

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

Sample Result 示例结果 

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

System

web/json/apps/verify

说明Description
Verifies a URL is valid

User Role用户角色

Admin

方法Method
HTTP HEAD

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • url - URL to test

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

web/json/console/setting/message/list

说明Description
Retrieves all messages added in Manage Messages管理信息

User Role用户角色

Admin

方法Method
HTTP GET/POST

Parameters参数

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method（可选）调用此方法后调用的函数（在JavaScript中）
  • 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)（可选）布尔值，用于确定是按升序还是降序排序（true等于降序）

  • start - (Optional) where rows start from（可选）行从哪里开始

  • rows - (Optional) number of rows per page（可选）每页的行数

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

Sample Result 示例结果 

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

web/json/hash/options

说明Description
Retrieves all available Hash Variable syntax

User Role用户角色

Admin

方法Method
HTTP GET/POST

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

Sample Result 示例结果 

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

说明Description
To tests a JDBC connection

User Role用户角色

Admin

方法Method
HTTP GET/POST

Parameters参数

• • datasource - Profile name. Not used.
  • driver - driver name 
  • url - connection URL
  • user - username
  • password - password
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • password - password
  • callback - （可选）调用此方法后调用的函数（在JavaScript中）