REST interface for BPD-related resources - Team Task Trend Resource - GET Method

Use this method to retrieve the tasks turnover rates (numbers of tasks created and completed hourly or daily) for a team managed by the calling user.

Sample method invocation

GET /rest/bpm/wle/v2/dashboards/teamtasktrend/{teamId}[?units={string}][&numPeriods={integer}][&endPeriod={string($date-time)}][&timeZone={string}][&searchFilter={string}]

Parameters

Optional parameters

Name	Value Type	Description
units	string	Use HOUR for hourly turnover rate, DAY for daily turnover rate. If this parameter is not specified, the default value of HOUR (hourly turnover rate) is used. Available values : DAY, HOUR
numPeriods	integer	The number of data points (turnover rate for one specific day or hour) to return. If this parameter is not specified, the default value of 24 is used for hourly turnover rate, or of 14 for daily turnover rate.
endPeriod	string($date-time)	last date/time for which a turnover rate should be returned (ISO 8601 formatted date). If this parameter is not specified, the current date/time is used.
timeZone	string	The time zone for the endPeriod and the results. It can be provided as an IANA time zone id (example: America/Los_Angeles) or as a GMT offset between GMT-18:00 and GMT+18:00 included (example: GMT+01:00). If this parameter is not specified, the default time zone is GMT.
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

Lists of turnover rate data points (one per hour or day for the requested period).

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"
		}
	],
	"data": [
		{
			"created": 0,
			"completed": 0,
			"timestamp": "2020-06-15T00:00:00.000Z"
		},
		{
			"created": 1,
			"completed": 1,
			"timestamp": "2020-06-16T00:00:00.000Z"
		},
		{
			"created": 0,
			"completed": 0,
			"timestamp": "2020-06-17T00:00:00.000Z"
		},
		{
			"created": 88977,
			"completed": 28635,
			"timestamp": "2020-06-18T00:00:00.000Z"
		},
		{
			"created": 0,
			"completed": 0,
			"timestamp": "2020-06-19T00:00:00.000Z"
		}
	],
	"queryExecuteTime": "2020-07-01T09:47:23Z"
}

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 Task Trend Resource