Zephyr: Get Test Executions
zephyr_get_test_executionsRetrieve test executions from Zephyr using filters like project key, test cycle, test case, date range, and pagination. Includes options for step links and last executions only.
Instructions
Get test executions with optional filters
Toolset: Test Executions
Parameters:
projectKey (string): Jira project key filter
testCycle (string): Test cycle key filter.
testCase (string): Test case key filter.
actualEndDateAfter (string): Filter for 'Actual End Date' after the given time. Format: yyyy-MM-dd'T'HH:mm:ss'Z'
actualEndDateBefore (string): Filter for 'Actual End Date' before the given time. Format: yyyy-MM-dd'T'HH:mm:ss'Z'
includeStepLinks (boolean): If true, execution step issue links will be included in the response (default: false)
jiraProjectVersionId (number): Jira Project Version ID. Relates to 'Version' or 'Releases' in Jira projects.
onlyLastExecutions (boolean): If true, includes only the last execution of each test cycle item (test case), and all ad-hoc test executions. (default: false)
limit (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 limit value in the response to confirm how many results were actually returned. (default: 10)
startAtId (number): Zero-indexed starting position for ID-based pagination. (default: 0)
Examples:
Get the first 10 test executions
{
"limit": 10,
"startAtId": 0
}Expected Output: The first 10 test executions with their details
Get 5 test executions for the project PROJ
{
"projectKey": "PROJ",
"limit": 5
}Expected Output: Up to 5 test executions for project PROJ
Get some test executions that finished after 01/Jan/2024
{
"actualEndDateAfter": "2024-01-01T00:00:00Z"
}Expected Output: Test executions that ended after 2024-01-01
Get test executions with step links included
{
"includeStepLinks": true
}Expected Output: Test executions with step links included
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | 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 limit value in the response to confirm how many results were actually returned. | |
| testCase | No | Test case key filter. | |
| startAtId | No | Zero-indexed starting position for ID-based pagination. | |
| testCycle | No | Test cycle key filter. | |
| projectKey | No | Jira project key filter | |
| includeStepLinks | No | If true, execution step issue links will be included in the response | |
| actualEndDateAfter | No | Filter for 'Actual End Date' after the given time. Format: yyyy-MM-dd'T'HH:mm:ss'Z' | |
| onlyLastExecutions | No | If true, includes only the last execution of each test cycle item (test case), and all ad-hoc test executions. | |
| actualEndDateBefore | No | Filter for 'Actual End Date' before the given time. Format: yyyy-MM-dd'T'HH:mm:ss'Z' | |
| jiraProjectVersionId | No | Jira Project Version ID. Relates to 'Version' or 'Releases' in Jira projects. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | No | ||
| limit | Yes | ||
| values | No | ||
| nextStartAtId | Yes |