Skip to content

QaCONNECT REST API

← QaCONNECT - Integrate w/ CI/ALM Tools
QaCONNECT REST APIs are a set of very powerful and secure REST APIs that  you can integrate with/within your Continuous Integration (CI) tools or custom created programs like for example a Dashboard type application, and  will let you "remotely" do the following interactions;
  • Trigger executions of Run Definitions, optionally 

    • overriding Data File bindings, File bindings, User-Defined Variables, Labels and Asset or Log File Capture settings

    • specifying "Number of Batch Runs","Test Execution Time","Batch Size" and "Time lag between Batches", in case you want to trigger the same tests multiple times (even 100s or 1000s of times) in the context of perfomance or load tests.

  • Upload test data like Data Files, Files and Labels
  • Get a list of Run Definition executions that are currently executing or have executed in the past AND Inquiring on the status of Run Definition executions

  • Get result summary for multiple Runs in Domain in XML or JSON format

  • Get Assets (Screenshots, Videos, and logs ) metadata and also the file contents

  • Get list of test data files (Data Files, Files) generated for a specific execution of Run Definition

  • Download the Test Data -Data Files and Files for specific execution in a Domain

  • Abort/Stop executions of Run Definitions

  • Check status of QaCONNECT REST APIs

  • create and manage Test Cycles within a project. The following actions can be performed:

    • define/configure a test cycle for a specific Project within your Worksoft SaaS Domain.

    • mark (record) the completion of all tests that you intended to get executed within a Test Cycle.

    • stop/abort all currently scheduled, queued or in-progress tests that you have triggered for execution within the Test Cycle.

    • (re-)open a Test Cycle that is currently 'closed'.

    • request a summary of status of execution of test runs within a specific test cycle, via email and/or Slack.

    • consolidate data from clipboards (that are populated by automated test runs with data from run-level datasets using the command 'ddPersistDatasetToTestCycleClipboard') which are scoped at the level of a test run id (within a test cycle) to 'output' that is at the level of "test cycle".
You can refer to the docs page for more details accessible at https://www.web.worksoft.cloud/docs/#/100  

Worksoft SaaS supports versions of the QaCONNECT REST API to have the flexibility to rollout changes and enhancements to the various services offered within the API while giving its customers adequate time to migrate to the latest versions. To understand the API versioning strategy and how to access the list of changes/enhancements implemented by version of the API, please click here.

For each REST call, the "Docs" page provides one or more examples and for each example, sample Request and Response is provided.

Please note that if you are logged into your Worksoft SaaS domain, you can also access the “Docs” page from “More” main menu item and sub-menu “QaCONNECT REST API Docs”. This sub-menu item when accessed will open the docs page in a new browser.




Feedback and Knowledge Base

(thinking…)