The request includes query parameters for the project key, start index, and limit.
API Endpoint
{{apiUrl}}/api/v1/category/caseTypes?projectKey={{projectKey}}
Headers
To authenticate the API request, you need to provide the Vansah Connect Token that is generated from the Jira workspace's Vansah configuration page.
Authorization | {{vansahConnectToken}}
|
Request Query Parameters
startAt | {{startAt}}
|
limit | {{limit}}
|
projectKey | {{projectKey}} Jira Project Key (Required for connect API calls), e.g. ("TEST", "PRODAPP") |
Response Body
success:
A boolean indicating whether the request was successful.message:
A message providing additional details about the response.pagination:
Provides information about the pagination of the data.total: Total number of labels available.startAt: The starting point for the data returned.limit: The number of labels that can be retrieved per request.
data:
A list of Test Case types returned from the API. Each Test Case Type has anamefield.
Example Response Body
{
"success": true,
"message": "CaseTypes returned successfully",
"pagination": {
"total": 6,
"startAt": 0,
"limit": 50
},
"data": [
{
"identifier": "8f16f456-a20d-11ef-99bc-4a527ec72f78",
"name": "Acceptance Test Scenario"
},
{
"identifier": "446b5362-a167-11ef-99bc-4a527ec72f78",
"name": "Functional"
},
{
"identifier": "bbd98652-f328-11ef-baf9-5a0ced9d1480",
"name": "new"
},
{
"identifier": "8996f147-a20d-11ef-99bc-4a527ec72f78",
"name": "Regression"
},
{
"identifier": "8a62c450-f312-11ef-baf9-5a0ced9d1480",
"name": "UI"
},
{
"identifier": "0ae0b3be-f331-11ef-baf9-5a0ced9d1480",
"name": "Unit"
}
]
}