Working with DevOps Test Hub REST services

When you want to use the REST APIs of HCL DevOps Test Hub (Test Hub) in your test automation scripts, you can view the REST APIs that are exposed by Test Hub. You can also run the APIs from within your project in Test Hub.

All REST services are accessible from the base URL of Test Hub and are defined by using Swagger. A navigable user interface lists the available set of APIs at <Test_Hub_URL>/#/Initial/Admin/docs. This Swagger file describes the individual APIs along with details of the parameters and response bodies.

You must be assigned the role of an administrator to be able to view or run the REST APIs.

After you log in to Test Hub with your credentials that has administrator privileges, you must go to the following URL: <Test_Hub_URL>/#/Initial/Admin/docs

The Swagger docs that are available can be viewed from the drop down list.

You can select the Swagger documentation for the REST APIs that you want to view or use. For example, you can select the /jobservicev2/api-docs to view the APIs for the execution micro-service.

You can perform the following steps to view or run the API:
  1. Expand the section to view the APIs that are available.
  2. Expand each of the APIs to view the details such as the description, examples, parameters, and responses.
  3. Click Try it out.
  4. Enter the values for the required parameters.
  5. Click Execute to run the API.

You can view the response after the API runs.

You can view the API doc for the execution micro-service that is extracted in this PDF document.