The command line API for QuerySurge is deprecated. We do recommend switching existing API calls to the REST API. Information on our REST API can be found here
The QuerySurge API breaks out into three areas:
- The QuerySurge Base API - a lightweight execution API, which allows users to drive QuerySurge execution from an external command line or scripting environment.
- The QuerySurge Test Management Tool Connector API - supports execution of QuerySurge from leading Test Management Tools (MicroFocus QualityCenter, Microsoft Azure DevOps and IBM Rational Quality Manager).
- The QuerySurge DevOps API - a full DevOps API supporting the majority of QuerySurge functions in an API context.
Note: The QuerySurge Base API is part of the core QuerySurge release and requires no additional licensing. The QuerySurge DevOps API is licensed separately. The Test Management Tool Connector API is also licensed separately. To arrange for licensing, contact info@querysurge.com or your QuerySurge Business Development representative.
QuerySurge APIs are installed from the QuerySurge installer. This installation is usually performed separately from your QuerySurge installation, and you may install the API components at any point after you have installed QuerySurge. Typically, you will not be co-installing API components with other QuerySurge components; rather, they are usually installed in locations where calling processes are running.
Note: While there are three APIs in QuerySurge, there are only two Installer options: one for QuerySurge APIs and the other for Test Management Tool Connectors. The QuerySurge APIs option installs both the Base API and the DevOps API, and the Test Management Tool Connectors option installs the Test Management Tool Connector API. Again, note that you will only have access to the DevOps API, and the Test Management Tool Connector API if you arrange for licensing.
API Installation (Windows)
- Double click to launch the QuerySurge Installer.
- Click on the Next button.
- Read the License Agreement, and then select the "I accept the agreement" radio button in order to continue with the installation of QuerySurge™. Click Next.
- Specify the installation directory and press the Next button.
- Select the QuerySurge APIs option, and deselect the other options. Click Next.
Note: When you install API components, the option QuerySurge APIs installs both the QuerySurge Base API and the QuerySurge DevOps API. The Test Management Tool Connectors is a separate option that installs the Test Management Tool Connector API.
- Select “Next” to start the installation.
- Click the “Finish” button to close the installer
API Installation (Linux)
The API can be installed on Linux just as it can be installed on Windows. The sequence of the installation process is the same as that shown above for Windows. Download the QuerySurge Linux installer to the location where you plan to install, and make the installer executable (this will require elevated rights). Issue the following command to launch the installer:
./querysurge-installer-x.x.x-linux-x64.run --mode text
1. Review the License Agreement and press Enter as prompted; it begins as follows:
------------------------------------------------------------------
Welcome to the QuerySurge Setup Wizard.
------------------------------------------------------------------
Please Please read the following License Agreement. You must accept the terms of this agreement before continuing with the installation.
Press [Enter] to continue :
EVALUATION AGREEMENT
THIS EVALUATION AGREEMENT ("AGREEMENT") IS ENTERED INTO BY AND BETWEEN REAL-TIME
TECHNOLOGY SOLUTIONS, INC. ("RTTS") AND "EVALUATOR". BY CLICKING ON THE
"ACCEPT" BUTTON, YOU OR THE ENTITY OR COMPANY THAT YOU REPRESENT ("EVALUATOR")
ARE UNCONDITIONALLY CONSENTING TO BE BOUND BY AND ARE BECOMING A PARTY TO THIS
AGREEMENT. EVALUATOR'S INSTALLATION AND USE OF THE PRODUCT SHALL ALSO
CONSTITUTE ASSENT TO THE TERMS OF THIS AGREEMENT. IF EVALUATOR DOES NOT
UNCONDITIONALLY AGREE TO ALL OF THE TERMS OF THIS AGREEMENT, CLICK THE "CANCEL"
BUTTON. IF THESE TERMS ARE CONSIDERED AN OFFER, ACCEPTANCE IS EXPRESSLY LIMITED
TO THESE TERMS. BY CLICKING ?ACCEPT? YOU ACKNOWLEDGE AND AGREE ON BEHALF OF
YOURSELF AND YOUR EMPLOYER TO BE BOUND TO THIS AGREEMENT. YOU REPRESENT THAT
YOU ARE AUTHORIZED TO ACCEPT THIS AGREEMENT ON YOUR EMPLOYER?S BEHALF.
2. To accept the License Agreement type "y" and press Enter:
Press [Enter] to continue :
Do you accept this license? [y/n]: y
3. To accept the default Directory press Enter, or insert name of Directory location and press Enter:
------------------------------------------------------------------
Please specify the directory where QuerySurge will be installed.
Installation Directory [/opt/QuerySurge]:
4. Type "y" to install the QuerySurge API Component and "N" for all other Components.
------------------------------------------------------------------
Select the components you want to install; clear the components you do not want to install.
Database [Y/n]: N
App Server [Y/n]: N
Agent [Y/n]: N
Tutorial + Sample Data [Y/n]: N
QuerySurge APIs [y/N]: Y
Test Management Tool Connectors [y/N]: N
5. Type "y" and press Enter to confirm selections:
Is the selection above correct? [Y/n]: y
6. Complete the remaining steps, accepting any defaults, and the installation will run.Note: When you install API components, the option QuerySurge APIs installs both the QuerySurge Base API and the QuerySurge DevOps API. The Test Management Tool Connectors is a separate option that installs the Test Management Tool Connector API.
QuerySurge Base API - Documentation
The QuerySurge Knowledge Base has multiple articles to help you get started with the Base API:
The QuerySurge Base API method calls are documented in this Knowledge Base article.
For discussions and examples of how to use the Base API, from beginning-level Use Cases to advanced-level Use Cases, see the following Knowledge Base articles:
- Using the QuerySurge Base API
- Base API Sample Batch Files (Windows)
- Base API Sample Shells (Linux)
- Troubleshooting QuerySurge Base API Issues
- Parameterizing your QueryPairs using Reusable Query Snippets and the Base API
- Scheduling QuerySurge with Jenkins and the QuerySurge Base API
QuerySurge DevOps API - Documentation
The QuerySurge DevOps API
Documentation for the QuerySurge DevOps API is found in the QuerySurge for DevOps Knowledge Base section. However, you will need to be logged in as a customer to view it. In addition, you will need to arrange for licensing to use the DevOps API.
Note: See the Resources section at the end of this article for information about the QuerySurge Test Management Tool Connector API.
Resources
The QuerySurge Test Management Tool Connector API
The following Knowledge Base article discusses installing and configuration the Test Management Tool Connector API component:
QuerySurge Test Management Tool Connectors
The specifics of configuring the API Connector to a given Test Management Tool appear in dedicated articles in the QuerySurge Integration section of the Knowledge Base.
Comments
0 comments
Article is closed for comments.