Returns a list of available projects.
Use the operation to get a list of projects available to the specified user in QAComplete.
In QAComplete, you can view and manage projects in > Setup > Projects (Open & Create).
To get information on an individual project, use the /projects/{ProjectId} (GET) operation.
Authentication
Basic authentication using a user’s login and password. See Authentication for details.
Security Rights
The authenticating user must have access to QAComplete projects.
Request Format
To get information on projects, send a GET request to the following URL:
offset : integer, default: 0
The number of projects to skip before counting the returned projects. 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 projects to return in the response.
A sample request:
GET http://yourserver.com/rest-api/service/api/v1/projects 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/v1/projects
Response Format
On success, the operation responds with HTTP status code 200 and returns a JSON object with project information.
If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.
A sample response:
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1197
{
"metadata": {
"result_set": {
"count": 1,
"offset": 0,
"limit": 25,
"total": 1
},
"permissions": {
"acl": 1
}
},
"results": [
{
"id": "11873",
"proj_name": "Orders",
"dept_id": "8162",
"dept_name": "Edgar Solutions",
"__permissions": {
"acl": 1
},
"actual_cost": 0,
"actual_hrs": 0,
"date_begin_actual": "00001-01-01T00:00:00.0000000",
"date_begin_scheduled": "2015-06-29T00:00:00.0000000",
"date_created": "2014-06-29T11:23:52.3970000",
"date_end_actual": "00001-01-01T00:00:00.0000000",
"date_end_scheduled": "2015-06-29T00:00:00.0000000",
"date_updated": "2014-06-29T11:23:52.3970000",
"est_cost": 0,
"est_hrs": 0,
"is_active": true,
"is_auto_calc": false,
"nbr_events": 0,
"nbr_files": 0,
"nbr_notes": 0,
"update_user_id": 24661,
"user_name": "Smith, John"
}
]
}
Metadata about the project list.
Pagination information about the project list. See Paging Through Results Using Offset and Limit.
The number of returned projects.
The offset of the first project requested.
The maximum number of projects requested.
The total number of projects.
The authenticating user’s rights to access projects.
Access rights:
- 0 - None
- 1 - Read
- 2 - Update
- 3 - Read and update
- 4 - Delete
- 5 - Read and delete
- 7 - Full access
An array of available projects.
The project’s department ID.
The department name.
The project name.
The unique identifier of the project.
The ID of the last user who updated the project.
The date and time when the project was created.
The date and time when the project was last updated.
The scheduled date and time when work on the project started.
The actual date and time when work on the project started.
The scheduled date and time when work on the project will complete.
The actual date and time when work on the project completed.
Estimated hours required to complete the project.
Actual hours spent working on the project.
The estimated cost of working on the project.
The actual cost of working on the project.
True if the project cost is estimated automatically.
True if the project is active and False if the project is hidden (archived).
The name of the last user, who updated the project, in the Lastname, Firstname format.
The number of notes attached to the project.
The number of calendar events attached to the project.
The number of files attached to the project.