Example: Viewing Certify Results with Certify Results API

This example shows you how to view Certify results with Certify Results API.

Prerequisites

  1. Generate a token in the Certify Results API. For more information, see Generating a Token in Certify Results API.
  2. If Microsoft® Excel® will be used to access data from Certify Results API, install the Microsoft Power Query plug-in. For more information, see https://support.microsoft.com/en-us/office/introduction-to-microsoft-power-query-for-excel-6e92e2f4-2079-4e1f-bad5-89f6269cd605 and https://www.microsoft.com/en-us/download/details.aspx?id=39379&CorrelationId=0a1fb29a-5281-4097-b3e6-431367168cc1.

API Endpoints

Microsoft Excel Example

  1. Open the Certify Results API Swagger page:

    http(s)://yourdomain/CertifyResultsAPI/swagger/ui/index

  2. Generate a token. For more information, see Generating a Token in Certify Results API.

  3. Add the API token to Swagger.

  4. Enter the required inputs to the GET /api/v1/projects/{projectName}/ResultFolders/{resultFolder} endpoint as described in the above API Endpoints section.

  5. Click the Try it out! button.

  6. Copy the URL that was generated in the Request URL section.

    Example:

    http://certifydemo/CertifyResultsAPI/api/v1/projects/Functional%20Tests/ResultFolders/%2FFunctional%20Tests%2FExecution%20Manager

  7. Open Microsoft Excel.

  8. Click the Data tab.

  9. From the Data tab, click the From Web button.

    The From Web dialog opens.

  10. Select the Advanced option.

  11. In the URL parts field, paste the resultsAPIResultsFolderUrl value.

  12. From the HTTP request header parameters (optional) field, enter token.

  13. In the second field, paste the resultsAPIToken value.

  14. Click OK.

  15. From the Query window in Microsoft Excel, edit the query name to Results.

  16. Click on the List link next to Results column.

  17. Click the To Table button to expand the data.

    The To Table dialog opens.

  18. Click OK.

  19. In the Queries window, click the Expand button on the right corner of the first column.

  20. Select the following columns:
  21. ResultOfRecord
  22. StartingProcessName
  23. LogHeaderID
  24. WallClockTime
  25. WallClockTimeSpan
  26. EndTime
  27. ResultFolder
  28. ProcessCount
  29. Status
  30. TestStepAbortCount
  31. TestStepCount
  32. TestStepFailedCount
  33. TestStepPassedCount
  34. TestStepSkippedCount
  35. TestStepsExecutedPerSound
  36. StartTime
  37. ResultsAttributeValues

  38. Expand the ResultFolder column and select the Full Path option.

  1. (Optional) Expand the ResultsAttributeValues column and select the result attributes you want to include.

  1. Click the Close & Load button.

    A new sheet with the tabular data is populated.

    The data can be used to create pivot tables and charts using Excel.

  2. Save the file.

  3. In the Data tab, click the Refresh All button to pull live data.

 

Related Topics Link IconRelated Topics