Returns a list of agile tasks created in the specified QAComplete project.
Use the operation to get a list of all the agile tasks registered in a QAComplete project.
To get parameters of an individual agile task, use the …/agiletasks/{Id} (GET) operation.
Authentication
Basic authentication using a user’s login and password. See Authentication for details.
Security Rights
The authenticating user must belong to a security group that has the Read privilege for Agile Tasks.
Request Format
To get information on agile tasks, send a GET request to the following URL:
ProjectId : integer, required
The ID of the project.
offset : integer, default: 0
The number of agile tasks to skip before counting the returned agile tasks. The default value is 0, which is the offset of the first item. For details, see Paging Through Results Using Offset and Limit.
limit : integer, default: 25
The maximum number of agile tasks to return in the response.
filter : string
The filter expression to apply to the returned list. See Search Filters.
A sample request:
GET http://yourserver.com/rest-api/service/api/v2/projects/11873/agiletasks HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==
A sample request made by using cURL:
curl -u [email protected]:p@ssword -H "Accept: application/json" http://yourserver.com/service/api/v2/projects/11873/agiletasks
Response Format
If successful, the operation responds with HTTP status code 200 and returns a JSON object with information about the agile tasks.
A sample response:
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 987
{
"metadata": {
"result_set": {
"count": 1,
"offset": 0,
"limit": 25,
"total": 1
},
"permissions": {
"acl": 7
}
},
"results": [
{
"project_id": 86763,
"id": 653888,
"task_type_code": "ProjectTasks",
"title": "New task",
"pct_complete": 0,
"est_hrs": 0,
"owner_user_id": 134087,
"assignee_user_id": 0,
"status_code": "Active",
"sort_order": 0,
"folder_id": 0,
"est_start": "2016-05-04T00:00:00.0000000",
"est_finish": "2016-05-06T00:00:00.0000000",
"act_start": "0001-01-01T00:00:00.0000000",
"act_finish": "0001-01-01T00:00:00.0000000",
"est_hrs_remaining": 10,
"act_hrs": 0,
"update_user_id": 134087,
"date_created": "2016-05-04T06:25:29.0970000",
"date_updated": "2017-10-03T17:41:14.3800000",
"user_name": "Smith, John",
"owner_name": "Smith, John",
"event_type": "Project Task",
"nbr_files": 0,
"nbr_notes": 0,
"nbr_events": 0,
"nbr_escalations": 87,
"date_last_escalated": "2016-05-04T20:53:14.1200000",
"last_escalation_rule_id": 1194,
"last_escalation_rule": "new rule",
"custom_fields": [],
"__permissions": {
"acl": 7
}
}
]
}
Metadata about the agile task list.
Pagination information about the agile task list. (See Paging Through Results Using Offset and Limit).
The number of returned agile tasks.
The offset of the first agile task requested.
The maximum number of agile tasks requested.
The total number of agile tasks.
The authenticating user’s rights to access the agile tasks.
Access rights:
- 0 - None
- 1 - Read
- 2 - Update
- 3 - Read and update
- 4 - Delete
- 5 - Read and delete
- 7 - Full access
An array of agile tasks.
The ID of the QAComplete project that contains the agile task.
The unique identifier of the agile task.
A string that represents the type code of the task.
The user-friendly name (title) of the agile task.
The percentage complete of the agile task’s implementation.
The estimated hours to implement the agile task.
The ID of the user who owns the agile task.
The ID of the user to whom the agile task is assigned. 0 if the agile task is not assigned to anyone.
The agile task’s status code.
The ordinal number of the agile task specified in the project.
The ID of the folder containing the agile task, or 0 if the agile task is not in any folder.
The estimated start date for the agile task.
The estimated finish date for the agile task.
The actual start date of the agile task.
The actual date when the agile task was implemented.
The estimated remaining hours for the agile task.
The actual hours spent implementing the agile task.
The ID of the user who updated the agile task last time.
The date and time when the agile task was created.
The date and time when the agile task was last updated.
The name of the user who last updated the agile task, in the LastName, FirstName format.
The name of the user who owns the agile task, in the Lastname, Firstname format.
The event type of the agile task.
The number of files attached to the agile task.
The number of notes attached to the agile task.
The number of calendar events attached to the agile task.
The number of times the agile task was processed by escalation rules.
The date when the agile task was last processed by an escalation rule.
The ID of the escalation rule that processed the agile task last. 0 if no escalation rule processed the agile task.
The name of the escalation rule that processed the agile task last.
An array of objects that describe custom fields and their values.
Error responses
If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.
If the project with the specified ProjectId does not exist or the authenticating user does not have rights to access the project, the operation returns the Access is denied error.