Page Comparison

...

Getting

...

Started

Cloud

URL

The APIs are available at the following base URL: https://tcms.aiojiraapps.com/aio-tcms/api/v1/

...

Requests made to AIO Tests REST APIs must be authenticated with an Access Token. More information is available here.

...

Requests made to AIO Tests REST APIs must be authenticated via Basic authentication or PAT authentication. More information is available here.

Swagger

...

Documentation

AIO Test APIs can be tried out via the Swagger page.
This page can be easily accessed by clicking on the question icon on the top right of the app and clicking ‘API Reference’.
APIs available in the Swagger documentation depend on the AIO Tests plugin version you have installed.

...

• Cycle Operations- Cycle operations like creating a cycle and deletion of cycle

  • Create new cycle- A new cycle gets created with details about the cycle.

  • Create new cycle from set- A new cycle gets created and cases from the set are added to the cycle.

  • Delete Cycle

• Execution Results & Case/Run managementManagement- The following actions can be performed via this API call.

  • Add Case to a Cycle- Existing cases can be added to a Cycle.

  • Add new Run for an existing Cases in a Cycle- New runs can be added for cases already in the Cycle.

  • Add case or run and mark the basic result of a case in cycle- Mark execution results for cases/runs in a Cycle.

  • Get Case Association list- Get a paginated list of all Case associations (Case, Association and Latest Run) in a Cycle.

  • Get all Cases with all runs- Get a paginated list of all Runs grouped by Case Association in a Cycle.

  • Get the Latest Run- Get the latest Run for a Case in a Cycle.

  • Get run details by run ID- Get all details of a specific run in a test case.

  • Attach evidence to the latest test run of a case- Attach files to a case execution.

  • Attach evidence to run by run ID- Attach files to a specific run.

  • Attach evidence to a step in a run- Attach files to a specific step in a run.

  • Update the entire run including steps- Update comments, defects, status, and actual results at run and step level.

  • Import Automated Test Results- This API can be used for uploading test automation execution results.

  • Reset a run- Reverts a run to its original status of Not Run and removes all artifacts.

• Case Information- The following GET calls can be used to get the list of cases and details of a case and map for different attributes defined for the project.

  • Case Details- Get case metadata like folder, tags, title, owner, status, etc.

  • Create Case- Create a case with basic details.

  • Case List- Get a paginated list of cases for the given project key.

  • Search Case- Get a paginated list of Cases matching the provided search criteria.

• Traceability- This call returns traceability information for specified Jira Issue IDs.

  • Traceability information- Get a 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 the 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.

...

In the 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 screenshot).

...

Understanding Permissions in API Responses

With the introduction of the Cross-Linking feature (release 2.1), Cases from different Projects can be added to a Cycle. Users who do not have access to a project, will not be able to access the Case / Run from that project in the Cycle.

To indicate the access user has on different Entities - Case / Cycle & Run, the Permission object will be returned in response.

Sample Permission object is below:

"permission": {
  "value": 7,
  "error": null
}

• Permission object has value and error properties.

• Value is a bit map where in bits from right to left represent the Delete, Write & Read permissions.
  7 - Full access (Delete, Write, Read)
  3 - Only Write and Read
  1 - Only Read
  0 - No permission

• Error is an enum indicating why the user does not have access over the cycle.
  The error can be one of:

  • EVALUATION_FAILED- There was an error while evaluating the permission value.

  • JIRA_PROJ_NO_ACCESS- The user does not have access to the entity as the User does not have permission on the entity’s Project.

  • AIO_TESTS_DISABLED_PROJ- The user does not have access to the entity as AIO Tests have been disabled for the entity’s Project.

  • AIO_TESTRUN_REFSTEP_NO_ACCESS- The user does not have access on the Run as one of the Referenced Step Cases is not accessible.

• If a user has permission (the error value is null), then an error will not be returned in the response.

The below table shows the Permission Values and Delete / Write / Read access it indicates.
If the bit is ON (having value 1), it means the user has permission to perform those operations.

 The below table shows the Run permissions based on the corresponding Cycle and Case access.

The user who has Read-only access to Run, will not be able to change the status of a run, but would be able to view its data. On trying to update such a Run using the API will return a 4xx response.

For further queries and suggestions, please feel free to reach out to our customer support service via help@aiotests.com.