Zephyr: Get Test Execution Steps
zephyr_get_test_execution_stepsRetrieve test execution steps from Zephyr for a given test execution ID or key, with optional pagination and test data row filtering to get specific step details.
Instructions
Get details of test execution steps in Zephyr
Toolset: Test Executions
Parameters:
testExecutionIdOrKey (string) required: The ID or key of the test execution. Test execution keys are of the format [A-Z]+-E[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)
testDataRowNumber (number): The id of the test data row to retrieve.
Examples:
Get the first 10 test execution steps for test execution with ID 1
{
"testExecutionIdOrKey": "1",
"maxResults": 10,
"startAt": 0
}Expected Output: The first 10 test execution steps with their details
Get the first 10 test execution steps for test execution with key 'SA-E1'
{
"testExecutionIdOrKey": "SA-E1",
"maxResults": 10,
"startAt": 0
}Expected Output: The first 10 test execution steps with their details
Get any test execution step for test execution with key 'SA-E1'
{
"testExecutionIdOrKey": "SA-E1",
"maxResults": 1
}Expected Output: One test execution step with its details
Get five test execution steps starting from the 7th test execution step for test execution with key 'SA-E1'
{
"testExecutionIdOrKey": "SA-E1",
"maxResults": 5,
"startAt": 6
}Expected Output: The 7th to the 11th test execution steps with their details
Get test execution steps from the test data row 1 from test execution with key 'SA-E1'
{
"testExecutionIdOrKey": "SA-E1",
"testDataRowNumber": 1,
"maxResults": 10,
"startAt": 0
}Expected Output: Test execution steps for the specified test data row
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. | |
| testDataRowNumber | No | The id of the test data row to retrieve. | |
| testExecutionIdOrKey | Yes | The ID or key of the test execution. Test execution keys are of the format [A-Z]+-E[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. |