Welcome
Tester Guide
This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing.
Tester Guide - API Testing
This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing. This guide is intended for API testers.
Working in non-GUI mode
You can use the tools and executable files that are provided along with the product software. You can use these tools to perform different test actions in a non-GUI mode.
Managing environments
Locking a HCL® Quality Server environment prevents other users from changing the state of that environment, for example, starting or stopping stubs.
Unlocking an environment by using the command line
You can unlock an environment by using the HCL OneTest™ API command line. This option is useful in situations where Ant is not available.

Release Notes
This document contains information about What's new, installation, known issues, known limitations, and contact information of HCL support.
System Requirements
This document includes information about hardware and software requirements for HCL OneTest™ API.
Getting Started
This guide provides an overview and describes the tasks to get you started with HCL OneTest™ API.
Administrator Guide
This guide describes how to install HCL OneTest™ API. After you install the software, you can perform administration tasks such as configuration and integration of the product. This guide is intended for administrators.
Tester Guide
This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing.
- Tester Guide - API Testing
  This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing. This guide is intended for API testers.
  - API Testing
    You can use find information about the tasks that you can perform for testing various domains, technologies, or applications.
  - Extending HCL OneTest™ API functionality by using custom functions
    You can add more calculations and operations to tests by using the HCL OneTest™ API custom function class. HCL OneTest API custom function is a Java™ class that extends the com.ghc.ghTester.expressions function.
  - Working in non-GUI mode
    You can use the tools and executable files that are provided along with the product software. You can use these tools to perform different test actions in a non-GUI mode.
    - Command-line interfaces
      HCL OneTest™ API command-line client is available in HCL OneTest API 8.0.1 or later.
    - Ant tasks
      You can use the supported Ant tasks that is supplied with HCL® Quality Server to create, update, or manage the environment, scenarios, and stubs.
    - REST services
      Representational state transfer (REST) is a simple stateless architecture that generally runs over HTTP. When used in conjunction with HCL® Quality Server, HTTP methods (such as GET and POST) are mapped to actions on domains, environments, scenarios, stubs and other resource types.
    - Running tests
      Use HCL OneTest™ API to run tests with command-line and Ant APIs.
    - Managing test results
      Use HCL® Quality Server to manage test results with command-line APIs.
    - Managing domains
      You can create, list, update, and delete domains with the HCL® Quality Server REST API.
    - Managing environments
      Locking a HCL® Quality Server environment prevents other users from changing the state of that environment, for example, starting or stopping stubs.
      - Locking an environment by using the command line
        You can lock an environment by using the HCL OneTest™ API command line. This option is useful in situations where Ant is not available.
      - Unlocking an environment by using the command line
        You can unlock an environment by using the HCL OneTest™ API command line. This option is useful in situations where Ant is not available.
      - Deleting an environment by using the command line
        You can delete an environment and its associated artifacts by using the HCL OneTest™ API command line. This option is useful in situations where Ant is not available.
      - Creating an environment by using an Ant task
        You can create an environment by using the HCL® Quality Server Ant task.
      - Deleting an environment by using an Ant task
        You can delete an environment and its associated artifacts by using the HCL® Quality Server Ant tasks.
      - Updating an environment by using an Ant task
        You can update values of the attributes of an environment by using the HCL® Quality Server Ant task.
      - Locking an environment by using an Ant task
        You can lock an environment by using the HCL® Quality Server Ant tasks.
      - Unlocking an environment by using an Ant task
        You can unlock an environment by using the HCL® Quality Server Ant tasks.
      - REST services
        Representational state transfer (REST) is a simple stateless architecture that generally runs over HTTP. When used in conjunction with HCL® Quality Server, HTTP methods (such as GET and POST) are mapped to actions on domains, environments, scenarios, stubs and other resource types.
    - Managing scenarios
      Use HCL® Quality Server to manage scenarios with command-line, Ant, and REST APIs.
    - Managing stubs
      You can manage stubs by using the command-line, Ant, and REST APIs.
- Tester Guide - Service Virtualization
  This guide describes the tasks that you can perform for using virtual services or stubs to simulate parts of an environment if the real services are not yet available or because they are difficult or expensive to use. This guide is intended for API Testers.
Test Manager Guide
This guide describes the tasks that you can perform for tracking the quality of the application. This guide is intended for Test Managers.
Troubleshooting
While working with HCL OneTest™ API, you might encounter some problems that you can easily troubleshoot.
Reference Guide
This guide provides the topics to help the API tester use the product by using the user interface, commands or scripts. This guide is intended for API testers.
Security Considerations
You can take certain actions to ensure that your installation is secure, customize your security settings, and set up user access controls.
Notices
This document provides information about copyright, trademarks, terms and conditions for product documentation.

Unlocking an environment by using the command line

You can unlock an environment by using the HCL OneTest™ API command line. This option is useful in situations where Ant is not available.

The syntax to use is as follows::

IntegrationTesterCmd Options unlock-environment

Here is an example syntax:

IntegrationTesterCmd --serverUrl "https://Hostname or IP address:5443/RTCP/" 
--domain <Domain name> --environment <Environment name> 
--username <User name> unlock-environment

The following table lists the options that you can use with the IntegrationTesterCmd command for unlocking an environment.

Table 1. List of available options
Option	Description
--serverUrl/-u	URL of HCL® Quality Server.
--domain/-d	Domain name
--environment/-e	Environment name
--username/-l	Specify the user name to authenticate with HCL® Quality Server to unlock the environment when the domain security is disabled.
--securityToken	Specify the security token generated for you to authenticate with HCL® Quality Server when the domain security is enabled. In the locked environment mode, the operation can be performed by the user who locked the environment.

Error codes

For details of any error codes, see Exit codes for Command-line client and Ant client.