This resource refers to releases. Use the release
resource to access release information using simple query or by using advance filters. You can also create a new release, update, archive or unarchive a specific release.
For more information, refer to the following documentation: Introduction to test planning.
Methods
Response body sample
{
"id": 299421,
"name": "Demo test",
"startTime": "2022-11-29",
"endTime": "2022-12-29",
"projectId": xxx,
"closed": false,
"createdAt": "2022-11-29T08:32:49.534+0000",
"externalRelease": {},
"releaseStatistics": {},
"builds": [],
"releaseStatus": "EMPTY"
}
Refer to the following table about the response body parameters:
Property | Type | Description |
---|---|---|
id | integer | The unique identifier of the release. |
name | string | The name of the release. |
startTime | date | The date when the planning of release should start. |
endTime | date | The date when the release should end. |
description | string | The description of the release. |
projectId | integer | The ID of the associated project. |
closed | boolean | true if the release is archived. |
createdAt | datetime | The date and time when the release is created. |
externalRelease | ExternalRelease object | The linked Jira release. See: Populate Jira releases. |
releaseStatistics | ReleaseStatistics object | This object contains statistics of the release: passed test cases, failed test cases, defects, etc. |
builds | array of build objects | The associated builds. See: Create and manage builds. |
releaseStatus | string | The status of the release:NOT_READY READY EMPTY |