The AIO Tests REST APIs provide programmatic integration with AIO Tests from any test framework in any language.
AIO Tests exposes endpoints to create execution cycles, report status for test case executions and get cycle details and summary for external reporting. The REST APIs give the flexibility to seamlessly integrate your automated tests, written in any language, into AIO Tests and get a single view of all automated and manual execution at one place.
This article explains the authorization mechanism and gives an overview of the available APIs.
AIO Test APIs can be tried out via Swagger page. This page can be easily access by clicking on the gear icon on top right of the app and clicking ‘API Reference’. APIs available in the Swagger documentation depends on the AIO Tests plugin version you have installed.
Click on Authorize button in Swagger page to provide Jira Username and Password (Basic Authentication) to authenticate and try out the APIs.
The following AIO Tests APIs have been exposed. Details around each of these APIs can be found in Swagger documentation.
Configuration - Get Project level configuration (Statuses, Folders, Tags etc)
Tags of the project - get list of the Tags (ID and Name) defined within AIO Tests for a given Jira Project. These details can be used to attach specific tags while creating new cycles.
Case Status list - get a list of the available Case Statuses (Draft, Published, Deprecated, etc.)
Case Type list - get a list of the Case Types defined for the project (Unit, Integration, Functional, etc.)
Case Priority list - get a list of the Case Priorities defined for the project (Critical, High, Low, etc.)
Case Script Type list - get a list of the Case Priorities defined for the project (Classic, BDD/Gherkin etc.)
Run Status list - get a list of the available Run Statuses (Passed, Failed, Blocked, etc.). These IDs can be used while updating status of existing cases in a cycle or to understand the test run distribution returned by the Get Cycle Summary call.
Project Configuration - get all project configuration in one call. The response will return list of Case Status, Case Automation Status, Case Type, Case Priority, Case Script Type, Run Status.
Cycle Information - following GET calls can be used to get different details of a cycle
Case List - get paginated list of cases for the given project key
Search Case - get paginated list of Cases matching the provided search criteria.
Traceability - this call returns traceability information for specified Jira Issue ID
Traceability information - get list of Cases associated with a Requirement/Jira issue ID. It will also return the latest Run information for the Case. Runs will be sorted in Descending order of Created date
Migration - these calls can be used to migrate data
Migrate Run - Migrate Run to for a Case to a Cycle. This allows creating a back dated entry for the Run.
You can also use the below sample Postman Collection to try out the Public APIs. Download and Import the collection into Postman.
In Postman collection, few collection level variables have been defined. Either update the variables directly in the requests or navigate to Edit Collection and update the variable values as per your Jira instance values (Refer to the below screen shot).