Zephyr: Get Test Case Steps
zephyr_get_test_case_stepsRetrieve test case step details from Zephyr by providing a test case key, with pagination options for large result sets.
Instructions
Get details of test case steps in Zephyr
Toolset: Test Cases
Parameters:
testCaseKey (string) required: The key of the test case. Test case keys are of the format [A-Z]+-T[0-9]+
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 case steps for test case with key 'SA-T1'
{
"testCaseKey": "SA-T1",
"maxResults": 10,
"startAt": 0
}Expected Output: The first 10 test case steps with their details
Get any test case step for test case with key 'SA-T1'
{
"testCaseKey": "SA-T1",
"maxResults": 1
}Expected Output: One test case step with its details
Get five test case steps starting from the 7th test case step of the list for test case with key 'SA-T1'
{
"testCaseKey": "SA-T1",
"maxResults": 5,
"startAt": 6
}Expected Output: The 7th to the 11th test case steps with their details
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| startAt | No | Zero-indexed starting position. Should be a multiple of maxResults. | |
| 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. | |
| testCaseKey | Yes | The key of the test case. Test case keys are of the format [A-Z]+-T[0-9]+ |
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 | The list of test steps | |
| 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. |