REST API (v1)
 |
For new development, it is strongly recommended to use Swagger API. REST API (v1) remains maintained however no further development is planned. For support information, see also: REST API (v1) support in Codebeamer.
|
The REST API is the replacement for the old Hessian-based Remote API (available at the /cb/remote-api URL) and offers the following advantages:
• Completely platform-independent.
• Completely stateless. No need to worry about closing sessions or expiring session timeouts.
• Completely self-describing.
• Locale aware: data is returned and can be submitted in the client/user's preferred language (as long as language is supported by the server).
• Based on open Web standards:
◦ HTTP for the communication protocol.
◦ JSON for the data interchange.
◦ JSON Schema for the data description.
• Clients do not need any Codebeamer client libraries nor any specific 3rd party libraries.
◦ In fact, you can use any web browser to execute/test queries (GET), by simply entering the URL of the query into the browser's address bar.
The URL of the REST API typically is: https://{hostname}/cb/rest
In the following sections, we will use the placeholder {RestURL} to refer to the URL of the REST API.
 |
For a better readability, we will omit the {RestURL} part when describing REST API methods and only show the relative URIs.
|