TaskListCount

Use this resource to get the number of tasks assigned to or completed by the user.

Method summary

HTTP Method	Path	Description
GET	/scr/api/TaskListCount	Gets the number of tasks that are assigned to or completed by the user.

GET /scr/api/TaskListCount

Description: Use this method to get the number of tasks assigned to or completed by the user.

Resource information

Requirements	Description
Response format	JSON
Requires authentication	Yes
Supports OAuth 2 client credentials	Yes using a User Service ID containing Work Management Category
Rate limited	Not yet

Parameters

Name	Location	Description	Required	Type
X-On-Behalf-Of	Header	The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any.	Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential.	String
type	Query	The type of tasks to be counted. The supported values are `assigned` or `completed`. If the value is not supported, the response code of `400` is returned.	Yes	String
version	Query	The version of the requested API. The only allowed value is `20110917`.	Yes	String

Response

Example input

Using User Service ID OAuth 2 client credentials:

curl -i -H "Authorization: Bearer access_token" 
"https://your_server_url/scr/api/TaskListCount?type=completed&version=20110917"

Using Service ID OAuth 2 client credentials:

curl -i -H "Authorization: Bearer access_token" 
    -H "X-On-Behalf-Of:user_name@domain.com" "https://your_server_url/scr/api/TaskListCount?type=completed&version=20110917"

Example output

{
    "count":17
}

Response properties

count: The total number of tasks of a specific type that are owned by the user.

Response messages

HTTP code	Reason
200	The request was completed successfully.
400	There was an error processing the request. Required parameters were missing or contained invalid values.
401	The user isn't authorized to make the request.