Working in non-GUI mode

Many test actions can be completed in non-GUI mode by using the command line, Ant, or REST interfaces.

Examples of processes that might run REST API commands include:

Automated build processes
Reporting tools
Plug-ins for other tools
Custom software programs

Many different programs can run REST commands. To run the command, you send an HTTP request to a REST resource and pass HTTP query parameters or a request body. The request body is typically in XML format, although a few resources use JSON.

Alternatively, build processes that already use the Apache Ant client can use the Ant API. When calling from other scripts, or executing commands manually, you can call the API directly from the command line, as in the following example:

GHTesterCmd --serverUrl "http://example.com:7819/RTCP/" --domain myDomain --environment localhost --name "My stub" start-stub

You can also call an Ant task from the command line.

Using the command line requires an installation of Rational® Integration Tester, and using Ant requires the Rational Test Control Panel Ant tasks archive file, as well as an installation of Ant. Stand-alone programs written in languages like Java and C# can call REST methods directly. For an example, see Example of calling REST API with Java HTTP.

The table below gives an overview of the actions that can be also be completed by using a non-GUI interface.

Table 1. Available actions and their associated interfaces
Actions	Command line	Ant tasks	REST services, grouped by resource type
Discovering REST APIs			REST APIs
Managing authentication for REST services			Get a list of URLs to use for authentication Sign in and create a session
Running tests	RunTests	GHTester
Managing test results	GHTesterCmd command delete-all-results delete-all-results-keeping
Managing domains			Domains Get a list of domains Domain Get a specific domain Create a domain Update the domain Delete the domain
Managing environments	GHTesterCmd command lock-environment unlock-environment	lockEnvironment unlockEnvironment	Environments Look up a URL for an environment Environment Get a specific environment Update the environment tags Delete an environment Environment lock Retrieve information on the existing lock, if any. Create an exclusive lock on an environment. Release an environment lock
Managing scenarios	GHTesterCmd command start-scenario stop-sceanrio	startScenario stopScenario	Scenarios Get a list of all scenarios Scenario Get a specific scenario Start a scenario Scenario instance (Running scenario) Stop a scenario
Managing stubs	GHTesterCmd command publish-stubs start-stub stop-stub	publishStubs startStub stopStub	Stub definitions Get a list of all stub definitions Stub definition Get a specific stub definition Start stub Stub definition configuration Get a specific stub definition configuration Stub instances Get a list of all stub instances Stub instance Get a specific stub instance (to determine its state) Stop a stub

Availability of the various interfaces

Command line: Both the RunTests and GHTesterCmd commands are supplied with Rational Integration Tester. For more information on the commands, see Command-line interfaces.
Ant: Support for the environment, scenario and stub Ant tasks is supplied with Rational Test Control Panel. Support for the GHTester Ant task is supplied only with Rational Integration Tester. For more information on the Ant tasks, see Ant tasks.
REST: The REST interfaces described here are only a set of specifications, so no client is provided. However REST calls must be made to an instance of Rational Test Control Panel. For more information on the REST services, see REST Services.

Domain level security

Note: By default, domain-level security is not enabled.

If domain-level security is enabled, a security token must be specified.

For the command-line, use the securityToken option.
For Ant tasks, use the securityToken attribute.
For the REST APIs, use the X-Jazz-Session Authorization header. For more details, see REST and Domain level security.

For information on how to create a security token, see Creating and assigning security tokens.

Feedback