JSON API

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

URL
/web/json/workflow/package/deploy

Method
HTTP POST

Description
Workflow package deploy

Parameters

appId - app ID
version - app version
packageXpdl - XPDL file

Sample Result

{"status":"complete"}

web/json/workflow/package/list

URL
/web/json/workflow/package/list

Method
HTTP GET

Description
Retrieve package (app) list

Parameters

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

Sample Result

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

web/json/workflow/process/list

URL
/web/json/workflow/process/list

Method
HTTP GET

Description
Retrieve process list

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

URL
/web/json/workflow/process/list/package

Method
HTTP GET

Description
Retrieve process list for process tree

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 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/(:processDefId)

Method
HTTP GET

Description
Get latest Process def Id

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

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

web/json/workflow/process/view/(:processDefId)

URL
/web/json/workflow/process/view/(:processDefId)

Method
HTTP GET

Description
View selected process

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

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

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

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

Method
HTTP POST

Description
Start process instance

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) 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"
}

The return of "activityId" is based on the value of "Show The Next Assignment When Completed" under "Run Process" in the activity mapping page. It also depends on whether an assignment exists for the current logged in user or not.

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

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

Method
HTTP POST

Description
Abort process instance

Parameters

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

Sample Result

{
  "id":"2117_CRM_newpkg1_wp1",
  "status":"aborted"
}

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

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

Method
HTTP GET

Description
Get process workflow variable

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
processId - process id
variable - variable id

Sample Result

{
  "variableValue":"approve"
}

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

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

Method
HTTP GET

Description
Retrieve total size of assignment pending list

Parameters

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

Sample Result

{"total":"3"}

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

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

Method
HTTP GET

Description
Retrieve total size of assignment accepted list

Parameters

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

Sample Result

{"total":"3"}

web/json/workflow/assignment/list/count

URL
/web/json/workflow/assignment/list/count

Method
HTTP GET

Description
Retrieve total size of assignment pending accepted list

Parameters

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

Sample Result

{"total":"1"}

web/json/workflow/assignment/list/pending

URL
/web/json/workflow/assignment/list/pending

Method
HTTP GET

Description
Retrieve workflow assignment pending list

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
processId - (Optional) process definition (Replace '#' with ":" in 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

Sample Result

{
  "total":2,
  "desc":true,
  "sort":"dateCreated",
  "start":0,
  "data":
  [
    {"id":"3893_3727_mdec_v1002_mdec_wp1_mdec_wp1_work",
      "activityId":"3893_3727_mdec_v1002_mdec_wp1_mdec_wp1_work",
      "processVersion":"2",
      "serviceLevelMonitor":"<span class=\"dot_red\"><\/span>",
      "processId":"3727_mdec_v1002_mdec_wp1",
      "description":"",
      "processName":"mdec_wp1",
      "due":"Fri Mar 20 13:57:37 SGT 2009",
      "dateCreated":"Fri Mar 20 13:55:37 SGT 2009",
      "label":"Work",
      "activityName":"Work"},
    {"id":"4001_3731_mdec_v1002_mdec_wp1_mdec_wp1_work",
      "activityId":"4001_3731_mdec_v1002_mdec_wp1_mdec_wp1_work",
      "processVersion":"2",
      "serviceLevelMonitor":"<span class=\"dot_red\"><\/span>",
      "processId":"3731_mdec_v1002_mdec_wp1",
      "description":"",
      "processName":"mdec_wp1",
      "due":"Fri Mar 20 14:06:22 SGT 2009",
      "dateCreated":"Fri Mar 20 14:04:22 SGT 2009",
      "label":"Work",
      "activityName":"Work"}
  ]
}

web/json/workflow/assignment/list/accepted

URL
/web/json/workflow/assignment/list/accepted

Method
HTTP GET

Description
Retrieve workflow assignment accepted list

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
processId - (Optional) process definition id (Replace '#' with ":" in 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

Sample Result

{
  "total":1,
  "desc":true,
  "sort":"dateCreated",
  "start":0,
  "data":
  [
    {"id":"8203_8001_mdec_v1002_mdec_wp1_mdec_wp1_review",
      "activityId":"8203_8001_mdec_v1002_mdec_wp1_mdec_wp1_review",
      "processVersion":"12",
      "serviceLevelMonitor":"<span class=\"dot_green\"><\/span>",
      "processId":"8001_mdec_v1002_mdec_wp1",
      "description":"",
      "processName":"mdec_wp1",
      "due":"-",
      "dateCreated":"Wed Apr 08 09:14:39 SGT 2009",
      "label":"Review",
      "activityName":"Review"}
  ]
}

web/json/workflow/assignment/list

URL
/web/json/workflow/assignment/list

Method
HTTP GET

Description
Retrieve workflow assignment pending accepted list

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
packageId- (Optional) Package id /App Id
processDefId- (Optional) Process Definition Id with version
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 Result

{
  "total":1,
  "desc":true,
  "sort":"dateCreated",
  "start":0,
  "data":
  [
    {"processId":"8203_8001_mdec_v1002_mdec_wp1_mdec_wp1_review",
      "activityId":"8203_8001_mdec_v1002_mdec_wp1_mdec_wp1_review",
      "processName":"mdec_wp1",
      "activityName":"Review",
      "processVersion":"12",
      "dateCreated":"Wed Apr 08 09:14:39 SGT 2009",
      "acceptedStatus":"true",
      "due":"-",
      "serviceLevelMonitor":"<span class=\"dot_green\"><\/span>",
      "id":"8001_mdec_v1002_mdec_wp1",
      "label":"Review",
      "description":""}
  ]
}

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

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

Method
HTTP GET

Description
Retrieve workflow assignment pending list for tree

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 Result

{
  "data":
  [
    { "count":6,
      "processVersion":"2",
      "processName":"mdec_wp1",
      "processDefId":"mdec_v1002#2#mdec_wp1",
      "label":"mdec_wp1 ver 2 (6)",
      "url":"/json/workflow/assignment/list/pending?processId=mdec_v1002%232%23mdec_wp1"},
    { "count":3,
      "processVersion":"3",
      "processName":"mdec_wp1",
      "processDefId":"mdec_v1002#3#mdec_wp1",
      "label":"mdec_wp1 ver 3 (3)",
      "url":"/json/workflow/assignment/list/pending?processId=mdec_v1002%233%23mdec_wp1"}
  ]
}

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

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

Method
HTTP GET

Description
Retrieve workflow assignment accepted list for tree

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 Result

{
  "data":
  [
    { "count":1,
      "processVersion":"12",
      "processName":"mdec_wp1",
      "processDefId":"mdec_v1002#12#mdec_wp1",
      "label":"mdec_wp1 ver 12 (1)",
      "url":"/json/workflow/assignment/list/accepted?processId=mdec_v1002%2312%23mdec_wp1"}
  ]
}

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

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

Method
HTTP GET

Description
Retrieve workflow assignment view

Parameters

callback - a function (in JavaScript) to call back after invoking this method
activityId - activity id

Sample Result

{
  "activityId":"12001_9801_service_center_newpkg1_wp1_newpkg1_wp1_act2",
  "processVersion":"4",
  "activityDefId":"newpkg1_wp1_act2",
  "processId":"9801_service_center_newpkg1_wp1",
  "assigneeId":"admin",
  "description":"",
  "processName":"Service Center Escalation Process",
  "dateCreated":"10-09-2009 10:45",
  "participant":"Level 2",
  "processDefId":"service_center#4#newpkg1_wp1",
  "variable":[
    {"relatedTo":""},
    {"ticketId":""},
    {"status":""},
    {"complexity":""},
    {"priority":""}],
  "activityName":"Update Ticket Level 2"
}

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

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

Method
HTTP GET

Description
Retrieve the first workflow assignment view of the currently logged in user.

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
processId - Process Instance ID

Sample Result

{
  "activityId":"12001_9801_service_center_newpkg1_wp1_newpkg1_wp1_act2",
  "processVersion":"4",
  "activityDefId":"newpkg1_wp1_act2",
  "processId":"9801_service_center_newpkg1_wp1",
  "assigneeId":"admin",
  "description":"",
  "processName":"Service Center Escalation Process",
  "dateCreated":"10-09-2009 10:45",
  "participant":"Level 2",
  "processDefId":"service_center#4#newpkg1_wp1",
  "variable":[
    {"relatedTo":""},
    {"ticketId":""},
    {"status":""},
    {"complexity":""},
    {"priority":""}],
  "activityName":"Update Ticket Level 2"
}

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

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

Method
HTTP POST

Description
Retrieve workflow assignment accept

Parameters

callback - a function (in JavaScript) to call back after invoking this method
activityId - activity id

Sample Result

{
    "assignment": "1079_563_crm_process1_approve_proposal",
    "status": "accepted"
}

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

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

Method
HTTP POST

Description
Withdraw activity

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
activityId - activity id

Sample Result

{
  "activityId":"11002_8702_aa_aa_wp1_org_wp1_act1",
  "status":"withdrawn"
}

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

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

Method
HTTP POST

Description
Set activity variable

Parameters

callback - a function (in JavaScript) to call back after invoking this method
activityId - activity id
variable - variable
value - value

Sample Result

{"status":"variableSet"}

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

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

Method
HTTP POST

Description
Set activity variable while completing an assignment activity
Variables can be passed as parameters with the var_ prefix

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
activityId - activity id
var_(workflow variable id) - (Optional) set workflow variable value

Sample Code

/web/json/workflow/assignment/completeWithVariable/1079_563_crm_process1_approve_proposal?var_id=123&var_status=approved

Sample Result

{
    "activityId": "1079_563_crm_process1_approve_proposal",
    "assignment": "admin",
    "nextActivityId": "1093_563_crm_process1_send_proposal",
    "processId": "563_crm_process1",
    "status": "completed"
}

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

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

Method
HTTP POST

Description
Complete assignment activity

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
activityId - Activity id

Sample Result

{
    "activityId": "1079_563_crm_process1_approve_proposal",
    "assignment": "admin",
    "nextActivityId": "1093_563_crm_process1_send_proposal",
    "processId": "563_crm_process1",
    "status": "completed"
}

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

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

Method
HTTP GET

Description
Retrieve workflow variable of a process.

Parameters

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

Sample Result

{
  "processId":"9801_service_center_newpkg1_wp1",
  "variable":
  [
    {"relatedTo":""},
    {"ticketId":""},
    {"status":""},
    {"complexity":""},
    {"priority":""}
  ]
}

web/json/workflow/process/sla/list

URL
/web/json/workflow/process/sla/list

Method
HTTP GET

Description
Retrieve process SLA list.

Prerequisites: Works only with Process Data Collector Plugin enabled.

Parameters

appId - app id
appVersion - app version

Sample Result

{
  "data":
  [
    {"processDefId":"process1",
      "processName":"Proposal Approval Process"
      "minDelay":100,
      "maxDelay":2220,
      "ratioWithDelay":10,
      "ratioOnTime":90,
      "serviceLevelMonitor":"<span class=\"dot_green\"><\/span>"}
  ]
  "total" : 1
}

web/json/workflow/activity/sla/list

URL
/web/json/workflow/activity/sla/list

Method
HTTP GET

Description
Retrieve activity SLA list.

Prerequisites: Works only with Process Data Collector Plugin enabled.

Parameters

appId - app id
appVersion - app version
processDefId - (Optional) process definition id without version

Sample Result

{
  "data":
  [
    {"activityDefId":"approve_proposal",
      "activityName":"Approve Proposal"
      "minDelay":100,
      "maxDelay":2220,
      "ratioWithDelay":10,
      "ratioOnTime":90,
      "serviceLevelMonitor":"<span class=\"dot_green\"><\/span>"},
    {"activityDefId":"activity1",
      "activityName":"Resubmit Proposal"
      "minDelay":100,
      "maxDelay":2220,
      "ratioWithDelay":10,
      "ratioOnTime":90,
      "serviceLevelMonitor":"<span class=\"dot_green\"><\/span>"}
  ]
  "total" : 2
}

web/json/monitoring/running/process/list

URL
/web/json/monitoring/running/process/list

Method
HTTP GET

Description
Retrieve running process list

Parameters

packageId - (Optional) package id
processId - (Optional) process definition id without version
processName - (Optional) process name
version - (Optional) process version
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 Result

{
  "total":2,
  "desc":false,
  "sort":"name",
  "start":0,
  "data":
  [
    {"id":"3724_mdec_v1002_mdec_wp1",
      "serviceLevelMonitor":"<span class=\"dot_red\"><\/span>",
      "name":"mdec_wp1","state":"open.running",
      "due":"Fri Mar 20 14:01:27 SGT 2009",
      "startedTime":"Fri Mar 20 13:51:27 SGT 2009","version":"2"},
    {"id":"3725_mdec_v1002_mdec_wp1",
      "serviceLevelMonitor":"<span class=\"dot_red\"><\/span>",
      "name":"mdec_wp1",
      "state":"open.running",
      "due":"Fri Mar 20 14:03:16 SGT 2009",
      "startedTime":"Fri Mar 20 13:53:16 SGT 2009",
      "version":"2"}
  ]
}

web/json/monitoring/completed/process/list

URL
/web/json/monitoring/completed/process/list

Method
HTTP GET

Description
Retrieve completed process list

Parameters

packageId - (Optional) package id
processId - (Optional) process definition id without version
processName - (Optional) process name
version - (Optional) process version
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 Result

{
  "total":2,
  "desc":false,
  "sort":"name",
  "start":0,
  "data":
  [
    {"id":"7401_mora_mora_new_application",
      "serviceLevelMonitor":"<span class=\"dot_green\"><\/span>",
      "name":"MORA New Application",
      "state":"closed.completed",
      "due":"-",
      "startedTime":"Fri Apr 03 11:00:42 SGT 2009",
      "version":"1"},
    {"id":"7607_mora_mora_new_application",
      "serviceLevelMonitor":"<span class=\"dot_green\"><\/span>",
      "name":"MORA New Application",
      "state":"closed.completed",
      "due":"-",
      "startedTime":"Fri Apr 03 12:36:09 SGT 2009",
      "version":"2"}
  ]
}

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

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

Method
HTTP POST

Description
Start a process instance with a copy over workflow variable from a running process, and start matching running activity in the new process instance

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
processId - process id
processDefId - process definition id
abortCurrent - (Optional) Boolean value to indicate whether to abort the running process instance or not

Sample Result

{
  "processDefId":"service_center#4#newpkg1_wp1",
  "processId":"9801_service_center_newpkg1_wp1",
  "activities":[
      "12001_9801_service_center_newpkg1_wp1_newpkg1_wp1_act2"
  ]
}

web/json/monitoring/activity/list

URL
/web/json/monitoring/activity/list

Method
HTTP GET

Description
Retrieve monitoring activity list

Parameters

processId - (Optional) process 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

Sample Result

{
  "total":2,
  "desc":false,
  "sort":"name",
  "start":0,
  "data":
  [
    {"id":"7836_7607_mora_mora_new_application_mora_new_application_act3",
      "serviceLevelMonitor":"<span class=\"dot_green\"><\/span>",
      "name":"Verify Application",
      "state":"closed.completed",
      "dateCreated":"Fri Apr 03 12:36:32 SGT 2009"},
    {"id":"7840_7607_mora_mora_new_application_mora_oral_writing_test",
      "serviceLevelMonitor":"<span class=\"dot_green\"><\/span>",
      "name":"Update Oral & Writing Test Result",
      "state":"closed.completed",
      "dateCreated":"Fri Apr 03 12:37:57 SGT 2009"}
  ]
}

web/json/monitoring/activity/reevaluate

URL
/web/json/monitoring/activity/reevaluate

Method
HTTP POST

Description
Evaluate assignment for activity

Parameters

activityId - Activity id

Sample Result

-

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

URL
/web/json/monitoring/activity/variable/(:activityId)/(:variable)
Method
HTTP POST

Description
Set value for variable

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
activityId - Activity id
variable - Variable
value - Value

Sample Result

{"status":"variableSet"}

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

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

Method
HTTP GET

Description
Retrieve workflow activity view

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
activityId - Activity id

Sample Result

{
  "activityId":"12001_9801_service_center_newpkg1_wp1_newpkg1_wp1_act2",
  "processVersion":"4",
  "activityDefId":"newpkg1_wp1_act2",
  "processId":"9801_service_center_newpkg1_wp1",
  "acceptedUser":"admin",
  "processName":"Service Center Escalation Process",
  "assignee":"admin",
  "participant":"level2",
  "processDefId":"service_center#4#newpkg1_wp1",
  "variable":
  [
    {"relatedTo":""},
    {"ticketId":""},
    {"status":""},
    {"complexity":""},
    {"priority":""}
  ],
  "activityName":"Update Ticket Level 2"
}

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

URL
/web/json/monitoring/activity/abort/(:processId)/(:activityDefId)
Method
HTTP POST

Description
Abort an activity in a process

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
processId - process id
activityDefId - activity definition id

Sample Result

{
    "processId":"mdec%239%23mdec_preseed_rejection",
    "activityDefId":"newpkg1_wp1_act2",
    "status":"aborted"
}

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

URL
/web/json/monitoring/activity/start/(:processId)/(:activityDefId)
Method
HTTP POST

Description
Start an activity in a process

Parameters

callback - (Optional) a function (in JavaScript) to call back after invoking this method
processId - process id
activityDefId - activity definition id
abortCurrent - (Optional) Boolean value to indicate whether to abort current running activity or not

Sample Result

{
    "processId":"mdec%239%23mdec_preseed_rejection",
    "activityDefId":"newpkg1_wp1_act2",
    "result":true
}

web/json/monitoring/activity/reassign

URL
/web/json/monitoring/activity/reassign

Method
HTTP POST

Description
Reassign assignee in an assignment

Parameters

activityId- activity Instance ID
username- new assignee (username)
replaceUser- assignee to be replaced (username)
callback - (Optional) a function (in JavaScript) to call back after invoking this method

Sample Result

{
    "activityId": "533_277_crm_process1_approve_proposal",
    "username": "cat",
    "replaceUser": "clark"
}

web/json/monitoring/user/reevaluate

URL
/web/json/monitoring/user/reevaluate

Method
HTTP POST

Description
Evaluate assignments for a user

Parameters

username - Username

Sample Result

-

web/json/workflow/currentUsername

URL
/web/json/workflow/currentUsername

Method
HTTP GET

Description
Get current logged in user's username

Parameters

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

Sample Result

{
    "username":"admin"
}

web/json/apps/published/userviews

URL
/web/json/apps/published/userviews

Method
HTTP GET

Description
Get a list of published user views

Parameters

appId - (Optional) App ID
callback - (Optional) a function (in JavaScript) to call back after invoking this method

Sample Result

{
    "apps": [{
        "id": "crm",
        "name": "CRM",
        "userviews": [{
            "id": "crm_userview_sales",
            "name": "CRM: Sales Force Automation",
            "url": "/jw/web/userview/crm/crm_userview_sales",
            "version": 1
        }],
        "version": 1
    }]
}

web/json/apps/published/processes

URL
/web/json/apps/published/processes

Method
HTTP GET

Description
Get a list of published processes

Parameters

appId - (Optional) app ID
callback - (Optional) a function (in JavaScript) to call back after invoking this method

Sample Result

{
    "apps": [{
        "id": "crm",
        "name": "CRM",
        "version": 1,
        "processes": [{
            "id": "crm#1#process1",
            "processVersion": "1",
            "appVersion": 1,
            "name": "Proposal Approval Process",
            "idWithoutVersion": "process1",
            "url": "/jw/web/client/app/crm/1/process/process1?start=true"
        }]
    }]
}

Space shortcuts

Page tree

JSON API

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

web/json/workflow/package/list

web/json/workflow/process/list

web/json/workflow/process/list/package

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

web/json/workflow/process/view/(:processDefId)

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

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

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

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

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

web/json/workflow/assignment/list/count

web/json/workflow/assignment/list/pending

web/json/workflow/assignment/list/accepted

web/json/workflow/assignment/list

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

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

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

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

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

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

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

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

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

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

web/json/workflow/process/sla/list

web/json/workflow/activity/sla/list

web/json/monitoring/running/process/list

web/json/monitoring/completed/process/list

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

web/json/monitoring/activity/list

web/json/monitoring/activity/reevaluate

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

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

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

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

web/json/monitoring/activity/reassign

web/json/monitoring/user/reevaluate

web/json/workflow/currentUsername

web/json/apps/published/userviews

web/json/apps/published/processes