Retrieve Certify Step Results with Certify Results API Swagger

With the Certify Results API Swagger, you can retrieve the Certify step results using the third GET method of ProjectV1. 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 must open Certify Results API to get your token and query ID.

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

    http://<servername>/CertifyResultsAPI

  2. Using your Worksoft Portal 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 you want to use in Swagger.

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

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

  2. In the api_key field, paste the token you copied.
  3. Click Explore.

  4. Expand ProjectV1 and click the third GET method to expand the operations.

  1. In the Parameters section, enter your project name in the projectName field.
  2. In the Parameters section, enter your result folder name in the resultFolder field.
  3. If you want to filter your results, you can add the following parameters to your request:
  4. Status
  5. Date
  6. Start date
  7. End date
  8. Attribute name
  9. Attribute value
  10. In the includeobjects drop-down list, select True or False to include Certify object information.
  11. If you want to pull results from a specific execution, enter values in the logHeaderID field.
  12. If you want to pull results from a specific process or execution, enter values in the logProcessID field.

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

    The step results are created.

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

 

Related Topics Link IconRelated Topics