REST interface for BPD-related resources - Team Member Summary Resource - GET Method

Use this method to retrieve statistics for a team member from a team managed by the calling user. The statistics cover all the tasks that are assigned to, or were completed today by the team member, whatever team those tasks are related to.

Sample method invocation

GET /rest/bpm/wle/v2/dashboards/teammember/{teamId}/{username}[?searchFilter={string}]

Parameters

Optional parameters
NameValue TypeDescription
searchFilter string
Provide search terms to filter the list of tasks on which the returned statistics are calculated. Task fields and business data fields that are available for search will be searched. Multiple terms can be separated by a space, in which case all of the terms must be found in a task. Wildcards can be included: ? for single character wildcards, * for variable length wildcards. To search for terms spelled similarly, use ~ at the end of the term.

Request content

None

Response content

Statistics for a team member from a team managed by the calling user.

The default content type is application/json.

MIME type: application/json


Schema
{
	"summary": {
		"tasksCompletedToday": 3,
		"emailAddress": "",
		"phoneNumber": "",
		"countOverdue": 1,
		"jobTitle": "",
		"name": "fdadmin",
		"fullName": "fdadmin",
		"countAtRisk": 0,
		"totalOpenTasks": 4,
		"countOnTrack": 3
	},
	"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-07-06T13:33:46Z"
}

Error Response content

None

Status codes

The method returns one of the following status codes:
CodeDescription
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 AcceptableThe 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 Member Summary Resource



Feedback