Versions Compared

Old Version 19

changes.mady.by.user Owen Ong

Saved on

compared with

New Version 20

changes.mady.by.user Owen Ong

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Description
Aborts a running process instance

User Role

Admin

Method
HTTP POST

Parameters

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

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

Sample Result

Code Block
languagejs
{"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

AdminURL/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 ResultURL

...

http:/

...

/

...

localhost:8080/

...

Description
Retrieves process list

User Role

Admin

URL
/jw/web/json/workflow/process/list

Method
HTTP GET/POST

Parameters

/latest/crm:1:process1

Sample Result

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

Sample URL

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

Sample Result

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

...

Method
HTTP GET/POST

Parameters

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

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

Sample Result

 

Code Block
{
    "data": [{
        "id": "morahr_expense",
        "count": 12,
        "processVersion": "53",
        "packageName": "MORAHR Expenses HalalClaim CertificationApp",
        "processId": "mora#5#morahr_new_applicationexpense#3#process1",
        "processName": "MORAExpense NewApproval ApplicationProcess",
        "packageId": "morahr_expense",
        "label": "MORAHR Expenses HalalClaim CertificationApp",
        "url": "/json/workflow/process/list?packageId=morahr_expense"
    }, {
        "id": "mdec_v1002isr",
        "count": 1,
        "processVersion": "122",
        "packageName": "Mdec Work ProgressISR",
        "processId": "mdec_v1002#12#mdec_wp1isr#2#isr",
        "processName": "mdec_wp1ISR Process",
        "packageId": "mdec_v1002isr",
        "label": "Mdec Work ProgressISR",
        "url": "/json/workflow/process/list?packageId=mdec_v1002isr"
    }, {
        "id": "hdc_v1001hrleave",
        "count": 12,
        "processVersion": "1",
        "packageName": "halalJINC certificationLeave Solution",
        "processId": "hdc_v1001#1#hdc_certification_processhrleave#1#la",
        "processName": "HDCLeave CertificationApplication ProcessSystem",
        "packageId": "hdc_v1001hrleave",
        "label": "halalJINC Leave certificationSolution",
        "url": "/json/workflow/process/list?packageId=hdc_v1001hrleave"
    }]
}
 

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

Description
Retrieve first process with details of every packagesStarts a process based on process start whitelist

User RoleAdmin

Anyone (Including anonymous)  

Method

HTTP GET/ POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • checkWhiteList -
    • processDefId - Process Definition Id (Replace '#' with ':' in the id)
    • processInstanceId - (Optional)
    • Boolean value
    • used to
    • return the list based on process white list
    • start the previous created but haven't start process instance
    • recordId - (Optional) used to start a process instance with existing record
    • var_* - (Optional) parameters prefixed with "var_" will be used to set workflow variable

Sample URL

http://localhost:8080/jw/web/json/workflow/process/list/packageSample Resultstart/crm:3:process1

Sample Result

Code Block
languagejs
{"activityId":"885_224_crm_process1_approve_proposal","processId":"224_crm_process1"}

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

Description
Retrieve first process with details of every packagesSets workflow variable 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
    • checkWhiteList - (Optional) Boolean value to return the list based on process white list
    • processId - process instnace id
    • variable - workflow variable name 
    • value - value of workflow variable to be set

Sample URL

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

Sample Result

Code Block
languagejs
{"status" : "variableSet"}

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

Description
Retrieve first process with details of every packagesRetrieves information of a process definition

User Role

Admin

Method

HTTP GET/POST

Parameters

    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • checkWhiteList
    • processId -
    • (Optional) Boolean value to return the list based on process white list
    •  Process Definition Id (Replace '#' with ':' in the id)

Sample URL

http://localhost:8080/jw/web/json/workflow/process/list/packageSample Resultview/crm:3:process1

Sample Result

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

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

...