REST interface for BPD-related resources - Team Summaries Resource - GET Method

Use this method to retrieve summary information about the tasks of each team managed by the calling user.

Sample method invocation

GET /rest/bpm/wle/v2/dashboards/teamsummary[?filter={string}][&size={integer}]

Parameters

Optional parameters

Name	Value Type	Description
filter	string	Filters the process app teams and includes only process app team names that match the specified filter condition. The filter is case-sensitive. By default, the method returns all the process app teams that are managed by the user. Example: "hiring*" returns all the process app teams whose name starts with "hiring".
size	integer	The maximum number of managed teams to retrieve summary information for. The default value is 100.

Request content

None

Response content

Lists task summary information for each team managed by the calling user.

The default content type is application/json.

MIME type: application/json

Schema

{
	"federationResult": [
		{
			"restUrlPrefix": "https://9.41.12.67:9443/rest/bpm/wle",
			"systemID": "4a8a5317-808e-48fe-964e-ff489ed356ce",
			"displayName": "BPM20002",
			"systemType": "SYSTEM_TYPE_WLE",
			"portalSupportUrlPrefix": "https://9.41.12.67:9443/portal",
			"id": "bpm20002",
			"taskCompletionUrlPrefix": "https://9.41.12.67:9443/teamworks",
			"version": "8.6.2.20002",
			"indexRefreshInterval": 2000,
			"statusCode": "200"
		}
	],
	"queryExecuteTime": "2020-08-04T11:22:54Z",
	"summaries": [
		{
			"tasksCompletedToday": 0,
			"processAppId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
			"processAppName": "Hiring Sample",
			"teamId": "24.eb30156e-52c8-4ec5-9be6-02290d02f827",
			"countOverdue": 0,
			"name": "GeneralManagers",
			"countAtRisk": 0,
			"description": "People who have authority to approve new positions.",
			"totalOpenTasks": 0,
			"countOnTrack": 0
		},
		{
			"tasksCompletedToday": 0,
			"processAppId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
			"processAppName": "Hiring Sample",
			"teamId": "24.6615a4b0-fd38-4ea5-8bc0-69d2f107369e",
			"countOverdue": 0,
			"name": "Human Resources",
			"countAtRisk": 0,
			"description": "People in the human resources department.",
			"totalOpenTasks": 0,
			"countOnTrack": 0
		},
		{
			"tasksCompletedToday": 0,
			"processAppId": "2066.1c793d64-d2bd-4302-a847-25a98f37c561",
			"processAppName": "Hiring Sample Advanced",
			"teamId": "24.7d98b271-207f-4483-ad00-fba01068b785",
			"countOverdue": 0,
			"name": "Managers",
			"countAtRisk": 0,
			"description": "",
			"totalOpenTasks": 0,
			"countOnTrack": 0
		},
		{
			"tasksCompletedToday": 0,
			"processAppId": "2066.1b351583-e5cb-43b7-baee-340a63130ea7",
			"processAppName": "System Data",
			"teamId": "24.da7e4d23-78cb-4483-98ed-b9c238308a03",
			"countOverdue": 0,
			"name": "All Users",
			"countAtRisk": 0,
			"description": "All Users represents all people in the system.",
			"totalOpenTasks": 28,
			"countOnTrack": 28
		},
		{
			"tasksCompletedToday": 0,
			"processAppId": "2066.1c793d64-d2bd-4302-a847-25a98f37c561",
			"processAppName": "Hiring Sample Advanced",
			"teamId": "24.dd406779-df57-4cef-89b2-b3c9fa197b77",
			"countOverdue": 1,
			"name": "General Managers",
			"countAtRisk": 0,
			"description": "",
			"totalOpenTasks": 1,
			"countOnTrack": 0
		},
		{
			"tasksCompletedToday": 0,
			"processAppId": "2066.1c793d64-d2bd-4302-a847-25a98f37c561",
			"processAppName": "Hiring Sample Advanced",
			"teamId": "24.013cbb68-094d-4281-8789-c2966f34d480",
			"countOverdue": 2,
			"name": "Hiring Managers",
			"countAtRisk": 0,
			"description": "",
			"totalOpenTasks": 2,
			"countOnTrack": 0
		},
		{
			"tasksCompletedToday": 0,
			"processAppId": "2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0",
			"processAppName": "Hiring Sample",
			"teamId": "24.cd97937f-06ab-43cc-8067-17dea489fdb3",
			"countOverdue": 0,
			"name": "HiringManagers",
			"countAtRisk": 0,
			"description": "People who have a department that needs a new position or have an existing position that needs to be filled.",
			"totalOpenTasks": 0,
			"countOnTrack": 0
		}
	]
}

Error Response content

None

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Successful operation.
401 Unauthorized	Unauthorized. The caller is not authorized for this request.
403 Forbidden	Forbidden. The caller is not allowed to complete this request.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	Internal Server Error. See the details provided.

Available since

24.0.0.1

Parent Topic: Team Summaries Resource