Page Comparison

...

Retrieving statistics about processes and tasks

/processTaskServices/

Method

get:/process-instances/deployedProcessCountcount

Description

Get the process count of the deployed processes.

Parameters

Header Parameter - Media types acceptable for the response. Default the default is JSON.

Return Type

Deployed processes with their process count.

Example Data

Code Block

language	jfx

{
 "data": [
 {
 "processDefinitionId": "helloWorldProcess:1:11",
 "deployedProcessCount": 1
 },
 {
 "processDefinitionId": "manualTaskProcess:1:15",
 "deployedProcessCount": 4
 }
 ]
}

Method

get: /processStatusCount/process-instances/state/all/count/

Description

Get the number of process instances with various states.

Parameters

Header Parameter - Media types acceptable for the response. Default the default is JSON.

Return Type

Count of process instances in each state.
States: Completed, Active, Suspended, Failed

Example Data

Code Block

language	jfx

{
 "data": [
 {
 "count": 2,
 "statusOfProcessOrTask": "Completed"
 },
 {
 "count": 4,
 "statusOfProcessOrTask": "Active"
 },
 {
 "count": 0,
 "statusOfProcessOrTask": "Suspended"
 },
 {
 "count": 0,
 "statusOfProcessOrTask": "Failed"
 }
 ]
}

Method

get: /taskStatusCount/task-instances/status/all/count

Description

Get the number of task instances with various states.

Parameters

Header Parameter - Media types acceptable for the response. Default the default is JSON.

Return Type

Count of task instances in each state.

States: Completed, Active, Suspended, Failed

Example Data

Code Block

language	jfx

{
 "data": [
 {
 "count": 4,
 "statusOfProcessOrTask": "Completed"
 },
 {
 "count": 4,
 "statusOfProcessOrTask": "Active"
 },
 {
 "count": 0,
 "statusOfProcessOrTask": "Suspended"
 },
 {
 "count": 0,
 "statusOfProcessOrTask": "Failed"
 }
 ]
}

Method

get: /avgDurationToCompleteProcess/process-instances/duration/average

Description

Get the average time duration of completed processes.

Parameters

Header Parameter - Media types acceptable for the response. Default The default is JSON.

Return Type

Completed processes and the average time duration for each process.

Example Data

Code Block

language	jfx

{
 "data": [
 {
 "processDefinitionId": "helloWorldProcess:1:11",
 "averageTimeForCompletion": 0.26085
 },
 {
 "processDefinitionId": "manualTaskProcess:1:15",
 "averageTimeForCompletion": 24.555516666666666
 }
 ]
}

Method

get: /avgTaskDurationForCompletedProcess/task-instances/duration/avarage/{pIdpid}

Description

Get the average time duration of each task in a completed process.

Parameters

pId: process Definition Id of the process (required).

Header Parameter - Media types acceptable for the response. Default The default is JSON.

Return Type

Completed tasks with their average time duration for each completed process.

Example Data

Code Block

language	jfx

Request – > /avgTaskDurationForCompletedProcess/task-instances/duration/avarage/manualTaskProcess:1:15

Code Block

language	jfx

{
 "data": [
 {
 "taskDefinitionKey": "orderConfirmed",
 "averageTimeForCompletion": 722751
 },
 {
 "taskDefinitionKey": "placeOrder",
 "averageTimeForCompletion": 4117232
 },
 {
 "taskDefinitionKey": "statusOfDelivery",
 "averageTimeForCompletion": 7973
 }
 ]
}

Method

get: /taskVariation/task-instances/count/variation

Description

Get the task variation over time i.e., tasks started and completed over the months.

Parameters

Header Parameter - Media types acceptable for the response. Default The default is JSON.

Return Type

Number of tasks started and completed over the months.

Example Data

Code Block

language	jfx

{
 "data": [
 {
 "startedInstances": 10,
 "completedInstances": 4,
 "month": "Jan"
 },
 {
 "startedInstances": 6,
 "completedInstances": 3,
 "month": "Feb"
 },
 {
 "startedInstances": 9,
 "completedInstances": 9,
 "month": "March"
 },
 {
 "startedInstances": 2,
 "completedInstances": 4,
 "month": "April"
 },
 {
 "startedInstances": 0,
 "completedInstances": 0,
 "month": "May"
 },
 {
 "startedInstances": 11,
 "completedInstances": 7,
 "month": "June"
 },
 {
 "startedInstances": 14,
 "completedInstances": 12,
 "month": "July"
 },
 {
 "startedInstances": 4,
 "completedInstances": 3,
 "month": "Aug"
 },
 {
 "startedInstances": 2,
 "completedInstances": 1,
 "month": "Sep"
 },
 {
 "startedInstances": 2,
 "completedInstances": 2,
 "month": "Oct"
 },
 {
 "startedInstances": 0,
 "completedInstances": 0,
 "month": "Nov"
 },
 {
 "startedInstances": 10,
 "completedInstances": 7,
 "month": "Dec"
 }
 ]
}

Method

get: /processVariation/process-instances/count/variation

Description

Get the process variation over time i.e., process instances started and completed over the months.

Parameters

Header Parameter - Media types acceptable for the response. Default The default is JSON.

Return Type

Number of process instances started and completed over the months.

Example Data

Code Block

language	jfx

{
 "data": [
 {
 "startedInstances": 3,
 "completedInstances": 3,
 "month": "Jan"
 },
 {
 "startedInstances": 10,
 "completedInstances": 5,
 "month": "Feb"
 },
 {
 "startedInstances": 8,
 "completedInstances": 6,
 "month": "March"
 },
 {
 "startedInstances": 3,
 "completedInstances": 2,
 "month": "April"
 },
 {
 "startedInstances": 14,
 "completedInstances": 12,
 "month": "May"
 },
 {
 "startedInstances": 20,
 "completedInstances": 12,
 "month": "June"
 },
 {
 "startedInstances": 6,
 "completedInstances": 3,
 "month": "July"
 },
 {
 "startedInstances": 0,
 "completedInstances": 0,
 "month": "Aug"
 },
 {
 "startedInstances": 6,
 "completedInstances": 1,
 "month": "Sep"
 },
 {
 "startedInstances": 9,
 "completedInstances": 7,
 "month": "Oct"
 },
 {
 "startedInstances": 11,
 "completedInstances": 10,
 "month": "Nov"
 },
 {
 "startedInstances": 6,
 "completedInstances": 3,
 "month": "Dec"
 }
 ]
}

Method

get: /allProcessesprocesses/

Description

Get all the deployed processes.

Parameters

Header Parameter - Media types acceptable for the response. Default The default is JSON.

Return Type

Deployed processes

Example Data

Code Block

language	jfx

{
 "data": [
 "helloWorldProcess:1:11",
 "manualTaskProcess:1:15",
 "testProcess:1:4",
 "userTaskProcess:1:10"
 ]
}

Retrieving statistics about users

/userServices/

Get all the users from store.

Method

get: /allUsers

Description

user

Parameters

Header Parameter - Media types acceptable for the response. Default is JSON.

Return Type

User list

Example Data

Code Block

language	jfx

{
 "data": [
 "admin",
 "testClerk"
 ]
 }

Method

get: /userVsTaskCount

Description

Get the number of completed tasks of the users.

Parameters

Header Parameter - Media types acceptable for the response. Default is JSON.

Return Type

Users with the number of tasks completed by each of them.

Example Data

Code Block

language	jfx

{
 "data": [
 {
 "userName": "admin",
 "taskCount": 4
 },
 {
 "userName": "testClerk",
 "taskCount": 3
 }
 ]
 }

Method

get: /userVsAvgTimeDuration

Description

Get the average time taken by each user to complete tasks.

Parameters

Header Parameter - Media types acceptable for the response. Default is JSON.

Return Type

Users with the average time taken by each user to complete tasks.

Example Data

Code Block

language	jfx

{
 "data": [
 {
 "userName": "admin",
 "avgTimeDuration": 372.24275
 },
 {
 "userName": "testClerk",
 "avgTimeDuration": 2740.863
 }
 ]
}

Method

get: /userTaskVariation-performance/variation/{assignee}

Description

Get the task variation of each user over time i.e., tasks started and completed by each user over the months.

Parameters

assignee: user (required).

Header Parameter - Media types acceptable for the response. Default is JSON

Return Type

Number of tasks started and completed over the months by the selected user.

Example Data

Code Block

language	jfx

{
 "data": [
 {
 "startedInstances": 3,
 "completedInstances": 4,
 "month": "Jan"
 },
 {
 "startedInstances": 10,
 "completedInstances": 8,
 "month": "Feb"
 },
 {
 "startedInstances": 6,
 "completedInstances": 5,
 "month": "March"
 },
 {
 "startedInstances": 4,
 "completedInstances": 2,
 "month": "April"
 },
 {
 "startedInstances": 9,
 "completedInstances": 10,
 "month": "May"
 },
 {
 "startedInstances": 7,
 "completedInstances": 6,
 "month": "June"
 },
 {
 "startedInstances": 5,
 "completedInstances": 2,
 "month": "July"
 },
 {
 "startedInstances": 0,
 "completedInstances": 0,
 "month": "Aug"
 },
 {
 "startedInstances": 1,
 "completedInstances": 1,
 "month": "Sep"
 },
 {
 "startedInstances": 2,
 "completedInstances": 2,
 "month": "Oct"
 },
 {
 "startedInstances": 10,
 "completedInstances": 6,
 "month": "Nov"
 },
 {
 "startedInstances": 5,
 "completedInstances": 4,
 "month": "Dec"
 }
 ]
}

...

Versions Compared

Old Version 1

New Version Current

Key

Retrieving statistics about processes and tasks

Retrieving statistics about users