GET/projects/{ProjectId}

Applies to QAComplete 14.5, last modified on August 06, 2024

Gets information on a project in QAComplete.

Use the operation to get information on a QAComplete project specified by its ID.

In QAComplete, you can view and manage projects on the  > Setup > Projects (Open & Create) screen.

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 an attachment, send a GET request to the following URL:

http://{server}/rest-api/service/api/v1/projects/{ProjectId}

ProjectId  :  integer, required

The ID of the needed project.

A sample request:

GET http://yourserver.com/rest-api/service/api/v1/projects/11873 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/11873

Response Format

On success, the operation responds with HTTP status code 200 and returns a JSON object with the project information.

A sample response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 737


{
  "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": "2014-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": "2016-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"
}
       

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.

Highlight search results