REST Services

Representational state transfer (REST) is a simple stateless architecture that generally runs over HTTP. When used in conjunction with IBM® Rational® Test Control Panel, HTTP methods (such as GET and POST) are mapped to actions on domains, environments, scenarios and stubs.

Overview

REST services are defined in the following specifications:

For more information about REST APIs, see:

To see how these REST APIs relate to the other APIs that are available, see Working in non-GUI mode.

RTCP Base URL

Many of the REST API Specifications refer to RTCP_BASE_URL. This is the base URL for accessing IBM Rational Test Control Panel. For example:

http://localhost:7819/RTCP/

REST response codes and error messages

If the response code is 400 or greater, and the Content-Type is text/plain, the response body contains a plain-text error message.

REST and Domain level security

Note: Domain-level security is supported in Rational Test Control Panel 8.5.1.1 or later. By default, domain-level security is not enabled.

If domain-level security is enabled a security token must be passed as a HTTP Request header.

Authorization: X-Jazz-Session token

where token is the string representing the security token. For information on how to create a security token, see Creating and assigning security tokens.

Feedback