GET/projects/{ProjectId}/releases/{Id}

Applies to QAComplete 12.84 SaaS, last modified on July 19, 2021

Gets information on a release from QAComplete.

Use the operation to get information on a release specified by its ID and by the ID of the project to which the release belongs.

To get a list of all the releases registered in a QAComplete project, use the …/releases (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 Releases.

Request Format

To get information on a release, send a GET request to the following URL:

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

ProjectId  :  integer, required

The ID of the project, to which the release belongs.

Id  :  integer, required

The ID of the release you want to get.

A sample request:

GET http://yourserver.com/rest-api/service/api/v1/projects/11873/releases/145910 HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==

A sample request made by using cURL:

curl -u john@example.com:p@ssword -H "Accept: application/json" http://yourserver.com/service/api/v1/projects/11873/releases/145910/

Response Format

If successful, the operation responds with HTTP status code 200 and returns a JSON object describing the release.

A sample response:

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



{
  "id": 145910,
  "project_id": 11873,
  "folder_id": 0,
  "release_id": 145910,
  "parent_id": 0,
  "release_type": "Release",
  "title": "The Sample Release",
  "owner_user_id: 135027,
  "assignee_user_id": 0,
  "is_auto_adjust_est_dates": false,
  "date_created": "2017-01-06T09:46:32.3100000",
  "date_updated": "2017-01-06T09:46:32.3100000",
  "create_user_id": 135027,
  "update_user_id": 135027,
  "is_active": false,
  "status_code": "In Progress",
  "est_start_date": "2012-02-27T00:00:00.0000000",
  "est_finish_date": "2012-03-27T00:00:00.0000000",
  "seq_num": 2,
  "import_id": 0,
  "parent_name": "",
  "updated_user_name": "Smith, John",
  "created_user_name": "Smith, John",
  "custom_fields": [],
  "__permissions": {
"acl": 7
}

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 a release with the specified Id does not exist, the operation returns the File or directory not found error.

See Also

Releases Resources

Highlight search results