Page History

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

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

Description
Starts a process based on process start whitelist

User Role

Anyone (Including anonymous)  

Method

HTTP POST

Parameters

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

  • processInstanceId - (Optional) used to start the previous created but haven't start process instance

    Info
    title Obtaining Latest Published Process Version
    Instead of specifying crm:3:process1 in the call, we can use the keyword latest in the processDefId - crm:latest:process1 to automatically set to the published app's process version.

  • 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/start/crm:3:process1

Sample Result

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

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

Description
Sets 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
  • 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/variable/208_crm_process1/status?value=test

Sample Result

{"status" : "variableSet"}

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

Description
Retrieves 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
  • processId - Process Definition Id (Replace '#' with ':' in the id)

Sample URL

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

Sample Result

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

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

Description
Retrieves all variables 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
  • processId - process instance id

Sample URL

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

Sample Result

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