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:
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 [email protected]: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
}
}
]
}
Metadata about the list of releases.
Pagination information about the list of releases. (See Paging Through Results Using Offset and Limit).
The number of returned releases.
The offset of the first release requested.
The maximum number of releases requested.
The total number of releases.
The authenticating user’s access rights to releases.
Access rights:
- 0 - None
- 1 - Read
- 2 - Update
- 3 - Read and update
- 4 - Delete
- 5 - Read and delete
- 7 - Full access
An array of releases.
The item’s ID.
The ID of the project that contains the item.
The ID of the project’s folder that contains the item. 0, if there is no folder.
The release’s ID. Equal to id for releases, equal to the parent’s release ID for iterations and builds.
The ID of the parent item (release or iteration) for iterations and builds.
The release’s type. Can be Release, Build or Iteration.
The item’s title.
The release’s owner ID.
The release’s assignee ID.
Defines whether QAComplete should automatically adjust estimated dates for this release.
The date the item was created.
The date the item was updated.
The ID of the user who created the release.
The ID of the user who updated the release last time.
Defines whether the release is active.
The release’s status code.
The estimated start date for working on the release.
The estimated finish date for working on the release.
The sequence number of the release.
The ID of the item the release settings were imported from.
The parent item’s name.
The user name of the user who updated the item.
The user name of the user who created the item.
A list of custom fields and their values.
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.