Zephyr: Get Test Cycles
zephyr_get_test_cyclesRetrieve test cycle details from Zephyr using filters for project, folder, or version. Supports pagination to control result size.
Instructions
Get details of Test Cycles in Zephyr
Toolset: Test Cycles
Parameters:
projectKey (string): Jira project key filter
folderId (number): Folder ID filter
jiraProjectVersionId (number): Jira Project Version ID. Relates to 'Version' or 'Releases' in Jira projects.
maxResults (number): Specifies the maximum number of results to return in a single call. The default value is 10, and the maximum value that can be requested is 1000.
Note that the server may enforce a lower limit than requested, depending on resource availability or other internal constraints. If this happens, the result set may be truncated. Always check the maxResults value in the response to confirm how many results were actually returned. (default: 10)
startAt (number): Zero-indexed starting position. Should be a multiple of maxResults. (default: 0)
Examples:
Get the first 10 Test Cycles
{
"maxResults": 10,
"startAt": 0
}Expected Output: The first 10 Test Cycles with their details
Get any Test Cycle
{
"maxResults": 1
}Expected Output: One Test Cycle with its details
Get five Test Cycles starting from the 7th Test Cycles of the list
{
"maxResults": 5,
"startAt": 6
}Expected Output: The 7th to the 11th Test Cycles with their details
Get one Test Cycle from the project PROJ
{
"projectKey": "PROJ",
"maxResults": 1
}Expected Output: One Test Cycle from project PROJ with its details
Get one Test Cycle from the folder with ID 123
{
"folderId": 123,
"maxResults": 1
}Expected Output: One Test Cycle from folder with ID 123 with its details
Get one Test Cycle from the version 456
{
"jiraProjectVersionId": 456,
"maxResults": 1
}Expected Output: One Test Cycle from version 456 with its details
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| startAt | No | Zero-indexed starting position. Should be a multiple of maxResults. | |
| folderId | No | Folder ID filter | |
| maxResults | No | Specifies the maximum number of results to return in a single call. The default value is 10, and the maximum value that can be requested is 1000. Note that the server may enforce a lower limit than requested, depending on resource availability or other internal constraints. If this happens, the result set may be truncated. Always check the maxResults value in the response to confirm how many results were actually returned. | |
| projectKey | No | Jira project key filter | |
| jiraProjectVersionId | No | Jira Project Version ID. Relates to 'Version' or 'Releases' in Jira projects. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | No | URL to the next page of results, or null if there are no more results. | |
| total | No | Indicates the total number of items available across all pages. | |
| isLast | No | Indicates if this is the last page of results. | |
| values | No | ||
| startAt | Yes | Indicates the index of the first item returned in the page of results. | |
| maxResults | Yes | Indicates the maximum number of results in this response. Note that the server may enforce a lower limit than requested, depending on resource availability or other internal constraints. |