Gets information on an agile task from QAComplete.
Use the operation to get information on an agile task specified by its ID.
To get information on all the agile tasks registered in a QAComplete project, use the …/agiletasks (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 an agile task, send a GET request to the following URL:
ProjectId : integer, required
The ID of the project, to which the agile task belongs.
Id : integer, required
The ID of the agile task you want to get.
A sample request:
GET http://yourserver.com/rest-api/service/api/v2/projects/11873/agile tasks/1 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/1
Response Format
On success, the operation responds with HTTP status code 200 and returns a JSON object with the agile task information.
A sample response:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 755
{
"project_id": 11873,
"id": 1,
"task_type_code": "ProjectTasks",
"title": "Sample agile task",
"pct_complete": 0,
"est_hrs": 0,
"owner_user_id": 146537,
"assignee_user_id": 0,
"status_code": "Active",
"folder_id": 0,
"est_start": "0001-01-01T00:00:00.0000000",
"est_finish": "0001-01-01T00:00:00.0000000",
"act_start": "0001-01-01T00:00:00.0000000",
"act_finish": "0001-01-01T00:00:00.0000000",
"est_hrs_remaining": 0,
"act_hrs": 0,
"update_user_id": 146537,
"date_created": "2019-07-08T08:27:26.7500000",
"date_updated": "2019-07-08T08:27:26.7500000",
"user_name": "Smith, John ",
"owner_name": "Smith, John ",
"event_type": "Project Task",
"nbr_files": 0,
"nbr_notes": 0,
"nbr_events": 0,
"nbr_escalations": 0,
"last_escalation_rule": "",
"custom_fields": [],
"__permissions": {
"acl": 7
}
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 to implement 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) a 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.
If does not exist, the operation returns the File or directory not found
error.
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.
If the agile task with the specified Id does not exist, the operation returns the File or directory not found
error.