GET/projects/{ProjectId}/releases

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

Returns a list of releases in the specified project.

Use the operation to get a list of all releases created in a QAComplete project.

To get information on a specific release, use the …/releases/{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 Releases.

Request Format

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

http://{server}/rest-api/service/api/v1/projects/{ProjectId}/releases?offset={offset}&limit={limit}&Filter={filter}

ProjectId  :  integer, required

The ID of the project.

offset  :  integer, default: 0

The number of releases to skip before counting the returned releases. 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 releases 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/v1/projects/11873/releases 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

Response Format

If successful, the operation responds with HTTP status code 200 and returns a JSON object with information about releases.

A sample response:

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



{
  "metadata": {
"result_set": {
  "count": 1,
  "offset": 0,
  "limit": 25,
  "total": 1
},
"permissions": {
  "acl": 7
}
  },
  "results": [
   {
  "id": 145908,
  "project_id": 101814,
  "folder_id": 0,
  "release_id": 145910,
  "parent_id": 0,
  "release_type": "Release",
  "title": "Sample Release",
  "owner_user_id": 0,
  "assignee_user_id": 0,
  "is_auto_adjust_est_dates": false,
  "date_created": "2017-04-06T09:46:32.3100000",
  "date_updated": "2017-04-06T12:45:12.0000000",
  "create_user_id": 135027,
  "update_user_id": 135027,
  "is_active": false,
  "status_code": "Closed (Canceled)",          "est_start_date": "2017-02-02T11:00:00.0000000",
  "est_finish_date": "2017-03-03T21:00:00.0000000",
  "seq_num": 2,
  "import_id": 0,
  "parent_name": "",
  "updated_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.

See Also

Releases Resources

Highlight search results