Zephyr: Get Statuses
zephyr_get_statusesRetrieve statuses of test artifacts (test cases, plans, cycles, executions) in Zephyr. Filter by project key and status type with pagination.
Instructions
Get statuses of different types of test artifacts in Zephyr
Toolset: Statuses
Parameters:
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)
projectKey (string): Jira project key filter
statusType (enum): Determines which type of entity the status belongs to.
Examples:
Get the first 10 statuses
{
"maxResults": 10,
"startAt": 0
}Expected Output: The first 10 statuses with their details from different projects and test artifact types
Get 10 test case statuses
{
"maxResults": 10,
"statusType": "TEST_CASE"
}Expected Output: A list of statuses related to test cases with their details
Get five statuses from the project PROJ
{
"maxResults": 5,
"projectKey": "PROJ"
}Expected Output: The first five statuses from the project PROJ 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. | |
| projectKey | No | Jira project key filter | |
| statusType | No | Determines which type of entity the status belongs to. |
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. |