Versions Compared

Old Version 6

changes.mady.by.user Hugo

Saved on

compared with

New Version Current

changes.mady.by.user Hugo

Saved on

Key

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

...

 

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

      Info
      titleObtaining 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.

    • processInstanceId - (Optional) used to 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/start/crm:3:process1

Sample Result

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

For "activityId" to be returned, please ensure the "Show The Next Assignment When Completed" is checked under the Run Process activity in Map Activities to Forms tab and the next activity after the start of process is assigned to the same person that starts the process.

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

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

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

Code Block
languagejs
{
    "processId": "208_crm_process1",
    "variable": {
        "status": "approved"
    }
}

 

...

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

...

http://localhost:8080/jw/web/json/directory/user/sso?j_username=admin&j_password=admin

Sample Result

Code Block
languagejs
{"username":"admin","isAdmin":"true", "token": "OWASP_CSRFTOKEN=7BKT-GL1V-Y5LR-T3JJ-41W2-JRBL-CCDB-7C03"}

web/json/workflow/currentUsername

...

Info
titleImportant Note

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

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