Retrieve Certify Step Results with Certify Results API Swagger

With Certify Results API Swagger, you can retrieve Certify step results with the third GET method. This GET method retrieves failed and/or aborted steps for a specified project.

To retrieve Certify step results:

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

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.

8. Click the third GET method to expand the operations.

   

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.
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. In the includeobjects drop-down list, select True or False.

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

    The step results are created.

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

 

Related Topics