Fetching execution results using Opkey APIs on Postman

Opkey provides APIs for fetching test execution results and other data in JSON format via tools like Postman and SoapUI. Additional APIs cover authorization token data, executed test suite info, and associated builds. Let's review them separately. 

Let's use Opkey APIs in Postman to fetch execution result details for Test Cases and Suites. The API URI includes the Opkey Web domain URL, Resource Path, and Query Parameters. 

Listed below are the Opkey APIs to fetch the desired outputs from the Opkey Project workspace. 


Authorize 


This API is used to fetch the Authorization Token of your Opkey environment by using your Opkey credentials using the POST method. 

Choose the POST method and input the API URL. Proceed to the Authorization tab, where you'll enter your Opkey Username and Password. Finally, click on Send to obtain the Authorization Token. 

 


The Authorization Token has been fetched which can be used in further APIs as input. 

 

GetSuiteResult 

 

This API fetches the execution result of a test suite from an Opkey project in JSON format. 

Choose the GET method and input the API URL. Navigate to the Params tab and enter the Query Parameters such as ProjectNameBuildName, and SessionName 


 



GetTestCaseResult 

 

This API fetches the details of the execution result of the Test Case in Suite. 

Choose the GET Method and input the API URL. Then, proceed to the Params tab to add Query Parameters such as ProjectNameBuildNameSessionName, and TestCaseStepID. 

 


Navigate to the Authorization tab and input the Authorization Token. Once done, click on the Send button to execute the GET Method and retrieve the execution result. 

You can review the details of the Test Case Execution Result in JSON format by accessing the Body tab. 

 

GetAllSessionsOfABuild 

This API fetches all the sessions from an executed build. 

Opt for the "GET Method" and input the API URL. Then, move to the "Params" tab to include query parameters such as Project Name and Build Name. 

 


Navigate to the "Authorization" tab and input the Authorization Token. After that, click on the "Send" buttonexecute the GET method, and retrieve the execution result. 

The results will now appear in the "Suite Execution Result" details in JSON format, accessible under the Body tab. 


 

GetAllSessionsOfProject 

This API fetches the details of the execution result of all sessions from a project. 

Select the “GET” method and enter the API URI, go to the “Params” tab, and enter the “Project Name”. 


 


Navigate to the Authorization tab and input the Authorization Token. Afterward, click on the Send button to execute the GET Method and fetch the execution result. 

You can review the details of the Test Case Execution Result in JSON format by accessing the Body tab. 

 

 



GetAllTagsOfSession 

 

This API retrieves details about the execution result of all tags within a session. 

 


Access the Authorization tab and input the Authorization Token. Then, click Send to execute the "GET" Method and fetch the execution result. 

You can view the details of the Test Case Execution Result in JSON format under the Body tab. 

 

GetAllMetadataBuild 

This API fetches the details about the Project’s MetadataBuild in Json format. 

Choose the Get Method and input the API URL. Then, move to the Params tab and input Query Parameters such as Project Name. 

Proceed to the Authorization tab and input the Authorization Token. Then, click on the Send button to execute the Get Method and retrieve the execution result. 


 

GetAllMetadataSessionOfBuild 

This API fetches all MetaData Session of Build in Json format. 

Select Get Method and input API URL. Move to Params tab and input Query Parameters as ProjectName = NameofProject & BuildName=NameofProject&BuildName 

 

 


GetSessionMetadata 

This API fetches the details about the execution result of the MetaData Session in JSON Format. 

Select Get Method and input the API URL. Move to the Params tab and input Query Parameters as ProjectName=NameofProject&SessionName 


 

 

You’re now at the end of the article. 

 

 

 

 

 

 

 

 

 

 

 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article