Detailed documentation on QMetry REST APIprovides all the details a developer would need for each of the API calls that are supported with code samples available in javascript, node.js, curl, C#, python, ruby and php.
...
A. Authentication
B. Grouping of APIs
...
Benefits of using QMetry API tool
...
QMetry authenticates all the REST API requests using api key. API Key can be generated from Jira, go to QMetry > Configuration > Open API. Here are the detailed steps.
...
Grouping of APIs
You can see the groups of APIs listed on the panel at left. Just click on the section you want to view and use the APIs of. The section is expanded on the left as well as on the right panel showing APIs under it.
...
You want to use API of Create new Test Case.
Expand the Test Case API group on the panel at left and select Create New Test Case API.
On the right panel, again click on the Create new Test Case API. It displays relevant Example on the third panel.
...
Understanding the Example
...
Request Type: API request type.
URL: The URL will remain same for all the users of QMetry for Jira Test Management Add-on for Cloud.
Request: Make sure you select Production server and select the language you want to generate the code in.
Headers: Provide API Key here. Generate your API Key for authentication from QMetry > Configuration > Open API > Generate.
Body: The section displays mandatory parameters for the API. If you want to view more available parameters, then click on Show JSON Schema as shown in the Additional Body Parameters .
Response: You can view corresponding response for the request.
...
Additional Body Parameters
...
If you want to try a live example of API, click on the Try button for the API request.
...
The console view switches to Example.
URL: The URL will remain same for all the users of QMetry for Jira Test Management Add-on for Cloud.
apiKey: Enter apiKey that you generated in QMetry for Jira Test Management (QMetry > Configuration > Open API > Generate).
...
Body: The Request Body displays mandatory system parameters. You can define more parameters for the API as per requirement. Refer to Additional Body Parameters.
...
Run API : Click "Call Resource" to run the API.
...
QMetry for Jira cloud Application has the below pre-defined API call limits to ensure optimum performance. However, depending upon the preferred usage of your automation teams and your server hardware capability, these limits may be modified.
API's | Maximum API Calls | Details |
|---|---|---|
All Open API's | 2500 Per Hour |
|