Monitoring

This page details the Monitoring endpoints and the actions they support. It provides sample URLs and results for quick reference, along with further instructions on how to use each endpoint.

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

Aborts an activity 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 instance id
  • activityDefId - activity definition id
• Sample URL: http://localhost:8080/jw/web/json/monitoring/activity/abort/208_crm_process1/send_proposal
• Sample Result:

{"activityDefId":"send_proposal","status":"aborted","processId":"208_crm_process1"}

web/json/monitoring/activity/list

Retrieves a list of all activities.

• User Role: Admin
• Method: HTTP GET/POST
• Parameters: 
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • processId - (Optional) process instance id for filtering
  • 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 URL:
• http://localhost:8080/jw/web/json/monitoring/activity/list?processId=116_hr_expense_process1
• Sample Result:

{
    "total": 3,
    "data": [{
        "id": "474_116_hr_expense_process1_approve_claim",
        "serviceLevelMonitor": "-",
        "name": "Approve Claim",
        "state": "open.not_running.not_started",
        "dateCreated": "15-07-2015 02:54 AM"
    }, {
        "id": "472_116_hr_expense_process1_new_claim",
        "serviceLevelMonitor": "-",
        "name": "Edit Claim",
        "state": "closed.completed",
        "dateCreated": "15-07-2015 02:53 AM"
    }, {
        "id": "473_116_hr_expense_process1_tool4",
        "serviceLevelMonitor": "-",
        "name": "Update Record Status to Submitted",
        "state": "closed.completed",
        "dateCreated": "15-07-2015 02:54 AM"
    }]
}

web/json/monitoring/activity/reassign

Reassigns a user to replace another user assigned to an assignment.

• User Role: Admin
• Method: HTTP POST
• Parameters: 
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • username - username that will replace the assigned user
  • replaceUser - username of an existing assignee of the assignment
  • activityId - activity instance id of the assignment
• Sample URL: http://localhost:8080/jw/web/json/monitoring/activity/reassign?activityId=841_206_crm_process1_send_proposal&username=admin&replaceUser=cat
• Sample Result: 

{"activityId":"841_206_crm_process1_send_proposal","username":"admin","replaceUser":"cat"}

web/json/monitoring/activity/reevaluate

Reevaluates an activity.

• User Role: Admin
• Method: HTTP POST
• Parameters: 
  • activityId - activity instance id to be reevaluated
• Sample URL: http://localhost:8080/jw/web/json/monitoring/activity/reevaluate?activityId=841_206_crm_process1_send_proposal
  

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

Starts an activity in 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
  • activityDefId - activity definition id
  • abortCurrent - (Optional) true or false value to abort all the running activities in the process instance
• Sample URL: http://localhost:8080/jw/web/json/monitoring/activity/start/116_hr_expense_process1/verify_claim
• Sample Result:

{"result":true,"activityDefId":"verify_claim","processId":"116_hr_expense_process1"}

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

Sets value to a workflow variable to a running activity instance.

• User Role: Admin
• Method: HTTP POST
• Parameters:
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • activityId - activity instance id
  • variable - workflow variable name
  • value - workflow variable value
• Sample URL: http://localhost:8080/jw/web/json/monitoring/activity/variable/474_116_hr_expense_process1_approve_claim/status?value=test
• Sample Result:

{"status":"variableSet"}

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

Retrieves information of an activity instance.

• User Role: Admin
• Method: HTTP GET/POST
• Parameters: 
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • activityId - activity instance id
• Sample URL: http://localhost:8080/jw/web/json/monitoring/activity/view/474_116_hr_expense_process1_approve_claim
• Sample Result:

{
    "processId": "116_hr_expense_process1",
    "serviceLevelMonitor": "-",
    "createdTime": "Wed Jul 15 10:54:10 MYT 2015",
    "processName": "Expense Approval Process",
    "assignee": "admin",
    "activityId": "474_116_hr_expense_process1_approve_claim",
    "activityDefId": "approve_claim",
    "processVersion": "1",
    "processDefId": "hr_expense#1#process1",
    "participant": "approver",
    "finishTime": "",
    "variable": {
        "status": "test"
    },
    "activityName": "Approve Claim",
    "dueDate": ""
}

web/json/monitoring/completed/process/list

Retrieves a list of all completed process instances.

• User Role: Admin
• Method: HTTP GET/POST
• Parameters:
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • packageId - (Optional) App/ package id
  • processId - (Optional) process instance id for filtering
  • processName - (Optional) process name for filtering
  • 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 URL: http://localhost:8080/jw/web/json/monitoring/completed/process/list?rows=3
• Sample Result:

{
    "total": 74,
    "data": [{
        "id": "133_hr_expense_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Expense Approval Process",
        "state": "closed.aborted",
        "due": "-",
        "startedTime": "29-07-2015 01:46 AM",
        "version": "2"
    }, {
        "id": "135_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "closed.aborted",
        "due": "-",
        "startedTime": "04-08-2015 09:28 AM",
        "version": "2"
    }, {
        "id": "136_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "closed.aborted",
        "due": "-",
        "startedTime": "04-08-2015 09:31 AM",
        "version": "2"
    }]
}

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

Copies the state and workflow variables of a running process instance to start a new 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
  • processDefId - process definition id to start a new process (replace "#" to ":")
  • abortCurrent - (Optional) true or false value to abort the current running process instance after start a new process instance
• Sample URL: http://localhost:8080/jw/web/json/monitoring/process/copy/116_hr_expense_process1/hr_expense:1:process1
• Sample Result

{
    "processId": "228_hr_expense_process1",
    "processDefId": "hr_expense#1#process1",
    "activities": [ "896_228_hr_expense_process1_approve_claim" ]
}

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

Sets a value to 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 instance id
  • variable - workflow variable name
  • value - workflow variable value
• Sample URL: 
• http://localhost:8080/jw/web/json/monitoring/process/variable/224_crm_process1/status?value=test
• Sample Result: 

{"status":"variableSet"}

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

Retrieves information 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/monitoring/process/view/224_crm_process1
• Sample Result:

{
    "requester": "admin",
    "serviceLevelMonitor": "-",
    "processId": "224_crm_process1",
    "name": "Proposal Approval Process",
    "finishTime": "",
    "states": ["open.running", "open.running"],
    "packageId": "crm",
    "processDefId": "crm#3#process1",
    "dueDate": "",
    "startedTime": "",
    "version": "3"
}

web/json/monitoring/running/activity/complete

Completes a running activity.

• User Role: Admin
• Method: HTTP POST
• Parameters: 
  • processDefId - process definition id (replace "#" to ":")
  • processId - process instance id
  • activityId - activity instance id
• Sample URL: http://localhost:8080/jw/web/json/monitoring/running/activity/complete?processDefId=crm:3:process1&processId=224_crm_process1&activityId=885_224_crm_process1_approve_proposal

web/json/monitoring/running/activity/reassign

Reassigns a user to replace another user assigned to an assignment. 

• User Role: Admin
• Method: HTTP POST
• Parameters: 
  • processDefId - process definition id (replace "#" to ":")
  • processId - process instance id
  • activityId - activity instance id
  • username - username that will replace the assigned user
  • replaceUser - username of an existing assignee of the assignment
• Sample URL: http://localhost:8080/jw/web/json/monitoring/running/activity/reassign?processDefId=crm:3:process1&processId=227_crm_process1&activityId=890_227_crm_process1_approve_proposal&username=cat&replaceUser=admin

web/json/monitoring/running/process/list

Retrieves a list of all running process instances.

• User Role: Admin
• Method: HTTP GET/POST
• Parameters: 
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • packageId - (Optional) app/package id
  • processId - (Optional) process instance id
  • 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 URL: http://localhost:8080/jw/web/json/monitoring/running/process/list?packageId=crm&rows=3
• Sample Result:

{
    "total": 16,
    "data": [{
        "id": "118_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "open.running",
        "due": "-",
        "startedTime": "21-07-2015 03:03 AM",
        "version": "1"
    }, {
        "id": "119_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "open.running",
        "due": "-",
        "startedTime": "21-07-2015 03:03 AM",
        "version": "1"
    }, {
        "id": "120_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "open.running",
        "due": "-",
        "startedTime": "21-07-2015 03:03 AM",
        "version": "1"
    }]
}

web/json/monitoring/user/reevaluate

Reevaluates all assignments of a user.

• User Role: Admin
• Method: HTTP POST
• Parameters: 
  • username - user to be reevaluate
• Sample URL: http://localhost:8080/jw/web/json/monitoring/user/reevaluate?username=cat