Zephyr: Get Test Cycle
zephyr_get_test_cycleRead-onlyIdempotent
Retrieve detailed information about a Zephyr test cycle using its ID or key.
Instructions
Get details of test cycle specified by id or key in Zephyr
Toolset: Test Cycles
Parameters:
testCycleIdOrKey (string) required: The ID or key of the test cycle.
Examples:
Get the test cycle with id 1
{
"testCycleIdOrKey": "1"
}Expected Output: The test cycle with its details
Get the test cycle with key 'SA-R40'
{
"testCycleIdOrKey": "SA-R40"
}Expected Output: The test cycle with its details
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| testCycleIdOrKey | Yes | The ID or key of the test cycle. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the entity | |
| key | Yes | Unique key of the test cycle | |
| name | Yes | Name of the Test Cycle | |
| links | No | Represents all links that a Test Cycle has. | |
| owner | No | ||
| folder | No | ID and link to the folder resource. | |
| status | Yes | ID and link to the status resource. | |
| project | Yes | ID and link relative to Zephyr project. | |
| description | No | Description outlining the scope. | |
| customFields | No | Multi-line text fields support HTML and should denote new lines with the \<br\> tag. Dates should be in the format 'yyyy-MM-dd'. Users should have values of Jira User Account IDs. | |
| plannedEndDate | No | The planned end date of the test cycle. This field cannot be blank. Setting it as null or excluding it from the request will leave the field values unchanged. ISO 8601 Format (i.e., yyyy-MM-dd'T'HH:mm:ss'Z') | |
| plannedStartDate | No | Planned start date of the test cycle. This field cannot be blank. Setting it as null or excluding it from the request will leave the field values unchanged. ISO 8601 Format (i.e., yyyy-MM-dd'T'HH:mm:ss'Z') | |
| jiraProjectVersion | No | ID and Link to fetch information about Jira Project version. Relates to 'Version' or 'Releases' in Jira projects. |