Page History

...

/json

...

/console/app/(:appId)/(:version)/package/deploy

URL
/web/json/workflow/package/deploy

...

Description
Workflow package deploy

Parameters

appId -

Sample Result

{"status":"complete"}

web/json/workflow/package/update

URL
/web/json/workflow/package/update

Method
HTTP POST

Description
Workflow package update

Parameters

...

App Id
version - App Version
packageXpdl - XPDL file

Sample Result

{"status":"complete"}

...

Description
Retrieve package (App) list

Parameters

• callback - a function (in javascript) to call back after invoke this method

Sample Result

{
  "totaldata":3,
  "data":
  [

  [
    {
        "packageId":"crm",
        {"packageIdpackageName":"aaCRM"
    },
    {
        "packageId":"mdechelpdesk"},
,        
        {"packageIdpackageName":"org"}Helpdesk"    
    }  
  ]
}

...

web/json/workflow/process/list

...

Description
Retrieve process list

Parameters

• callback - a (Optional) A function (in javascript) to call back after invoke this method
• allVersion - (Optional) "yes" to load all version, "no" to load latest version
• packageId - (Optional) package id (App id)packageId - package id
• sort - column (Optional) column name to be sort
• desc - boolean (Optional) boolean value to determine either sort by ascending or descending (true equals to descending)
• start - rows (Optional) rows start from
• rows - number (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"}
  ]
}

...

• callback - a function (in javascript) to call back after invoke this method
• checkWhiteList - (true/false) To return the list based on process white list

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/latest/(:

...

processDefId)

URL
/web/json/workflow/process/latest/(:processIdprocessDefId)

Method
HTTP GET

Description
Get latest process idProcess def Id

Parameters

• callback - a (Optional) A function (in javascript) to call back after invoke this method
• processId - process idprocessDefId - Process Definition Id (Replace '#' with ':' in the id)

Sample Result

{
  "id":"mdec#9#mdec_preseed_rejection",
  "encodedId":"mdec:9:mdec_preseed_rejection"
}

...

Description
View selected process

Parameters

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

Sample Result

{
  "id":"mdec%239%23mdec_preseed_rejection",
  "packageId":"mdec",
  "packageName":"MDEC Workflow",
  "name"=:"MDEC PreSeed Applicant Rejected",
  "version":"9"
}

...

Description
Start process instance

Parameters

• callback - a (Optional) A function (in javascript) to call back after invoke this method
• processDefId - Process Definition Id (Replace '#' with ':' in the id)
• processInstanceId - process definition id(Optional) Start process with an instanceId
• var_(workflow variable id) - (Optional) Set workflow variable value 

Sample Result

{
  "activityId":"2122_2117_CRM_newpkg1_wp1_newpkg1_wp1_act1",
  "processId":"2117_CRM_newpkg1_wp1"
}

...

Description
Abort process instance

Parameters

• callback - a (Optional) A function (in javascript) to call back after invoke this method
• processId - process id

Sample Result

{
  "id":"mdec%239%23mdec2117_CRM_preseednewpkg1_rejectionwp1",
  "status":"aborted"
}

...

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

...