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

Compare with Current View Page History

« Previous Version 7 Next »


App

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method
HTTP GET/POST

Parameters

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

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

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

 Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

 

web/json/apps/install

Description
Retrieve first process with details of every packages

User Role

Admin

 Method

HTTP GET/POST

 Parameters

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

Sample URL

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

Sample Result

 web/json/apps/published/processes

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


web/json/apps/published/userviews

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


web/json/console/app/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

 

Sample URL

 

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

 

Sample Result


web/json/console/app/(*:appId)/version/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


web/json/console/app/(*:appId)/(~:version)/envVariable/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

 

Sample URL

 

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

 

Sample Result


web/json/console/app/(*:appId)/(~:version)/datalist/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


web/json/console/app/(*:appId)/(~:version)/pluginDefault/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

 

Sample URL

 

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

 

Sample Result


web/json/console/app/(*:appId)/(~:version)/message/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

 

Sample URL

 

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

 

Sample Result


web/json/console/app/(*:appId)/(~:version)/userview/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


web/json/workflow/package/list

Description
Retrieves package (app) list

User Role

Admin

URL
/web/json/workflow/package/list

Method
HTTP GET/POST

Parameters

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

Sample Result

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

Assignments 

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

web/json/workflow/assignment/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/workflow/assignment/list/count

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


web/json/workflow/assignment/list/accepted

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


web/json/workflow/assignment/list/pending

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


Processes

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

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

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

User Role

Admin

URL
/web/json/workflow/process/list

Method
HTTP GET/POST

Parameters

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

Sample Result

web/json/workflow/process/list

Description
Retrieves process list

User Role

Admin

URL
/web/json/workflow/process/list

Method
HTTP GET/POST

Parameters

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

Sample Result

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

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

Sample Result

 

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

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

Monitoring

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

web/json/monitoring/activity/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/monitoring/activity/reassign

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

web/json/monitoring/activity/reevaluate

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

web/json/monitoring/completed/process/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

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

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

web/json/monitoring/running/activity/complete

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

web/json/monitoring/running/activity/reassign

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

web/json/monitoring/running/process/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/monitoring/user/reevaluate

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

SLA

web/json/workflow/activity/sla/list

Description
Retrieve first process with details of every packages

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

Audit Trail

web/json/workflow/audittrail/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

Directory

web/json/directory/admin/dept/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/directory/admin/employment/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/directory/admin/employment/noHaveOrganization/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/directory/admin/employment/noInDept/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/directory/admin/employment/noInGrade/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/directory/admin/group/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/directory/admin/grade/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/directory/admin/organization/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/directory/admin/subdept/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

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

 

Description
Retrieve first process with details of every packages

 

User Role

 

Admin

 

Method

 

HTTP GET/POST

 

Parameters

 

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

 

Sample URL

 

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

 

Sample Result


web/json/directory/admin/user/group/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

 

Sample URL

 

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

 

Sample Result


web/json/directory/admin/user/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/directory/admin/user/notInGroup/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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list

Sample URL

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

Sample Result

web/json/directory/user/sso

Description
To single sign on a user

User Role

Anonymous

Method

HTTP GET/POST, support HTTP basic authentication

Parameters

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

Sample URL

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

Sample Result

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

Sample 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

Sample 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

Sample 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

Sample 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 Plugin Properties Options of a plugin

User Role

Admin

Method

HTTP GET/POST

Parameters

    • value - Plugin class name

Sample URL

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

Sample Result 

[{
    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 Plugin Properties Options of a plugin based on App Definition meta

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

{
    "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 Plugin Properties Options of a plugin with App Definition meta

User Role

Admin

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result 

[{
    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
    • url - URL to test

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

web/json/console/setting/message/list

Description
Retrieves all messages added in Manage Messages

User Role

Admin

Method
HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • filter - (Optional) string to filter the results
    • locale - (Optional) language code to filter the results

    • sort - (Optional) column name to be sorted

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

    • start - (Optional) where rows start from

    • rows - (Optional) number of rows per page

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

Sample Result 

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

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

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

Sample Result 

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


  • No labels