Create a Results Query in Certify Results API Swagger

With Certify Results API Swagger, you are able to create a results query that will be used to retrieve Certify results, processes, and attributes.

Before you begin this process, you must have completed the following:

• Registered your Certify databases in the Worksoft Management Studio. For more information, see Registering Certify Databases for Certify Results API.
• Created a token in Certify Results API in order to access the API and to create results queries. For more information, see Generating a Token in Certify Results API.

You are able to use one of the following methods to create a results query:

• GET- Retrieves Certify results for the specified project and other filter criteria.
• POST - Retrieves Certify results for the specified project and other filter criteria.

To create a results query in Certify Results API Swagger with the GET method:

Before you open Certify Results API Swagger, you need to open Certify Results API to get your token.

1. Open Certify Results API on your Certify Services server with the following URL address:

   http://<servername>/CertifyResultsAPI

2. Using your Worksoft Management Studio credentials, enter your credentials and click Login.

   Certify Results API opens.

3. Click the Manage Tokens tab.

   

4. Click the Copy Token to Clipboard button next to the token that you want to use in Swagger.

5. Open Certify Results API Swagger through the following URL address:

   http://<servername>/CertifyResultsAPI/swagger/ui/index

6. In the api_key field, paste the token that you copied.

7. Click Explore.

   The Worksoft.Certify.ResultsAPI Swagger page opens.

   

8. Expand ProjectV1 and click the first GET method.

   

9. In the Parameters section, type your project name in the projectName field.
10. In the Parameters section, type your result folder name in the resultFolder field. The name should begin with /Client Project Name/QA Results.
11. If you want to filter your results, you can add additional parameters to your request, including status, dates, and attributes. These parameters are optional.

12. If you want to include all the log processes for the results, select true from the includeLogProcess drop-down list.

    If you do not want to include log processes, select false.

13. In the Response Messages section, click the Try it out! button to test the query.

    The Results Query is created.

    

14. Open the query in a reporting tool to visualize the results.

To create a results query in Certify Results API Swagger with the POST method:

Before you open Certify Results API Swagger, you need to open Certify Results API to get your token.

1. Open Certify Results API through the following URL address:

   http://<servername>/CertifyResultsAPI

2. Using your Worksoft Management Studio credentials, enter your credentials and click Login.

   Certify Results API opens.

3. Click the Manage Tokens tab.

   

4. Click the Copy Token to Clipboard button next to the token that you want to use in Swagger.

5. Open Certify Results API Swagger through the following URL address:

   http://<servername>/CertifyResultsAPI/swagger/ui/index

6. In the api_key field, paste the token that you copied.
7. Click Explore.

8. Click the POST method to expand the operations.

   

9. From the Response Content Type drop-down list, select application/json.
10. In the request field, type in your request value. Use the Example Value for guidance.

11. From the Parameter Content Type drop-down list, select application/json.

12. In the Response Messages section, click the Try it out! button to test the query.

    The Results Query is created.

13. Open the query in a reporting tool to visualize the results.

 

Related Topics