Swagger Documented - REST-Based API
How to use REST API
Endpoints are available on /v3/swagger/editor.spr URL, without any authentication.
 |
From Codebeamer 22.04 the API endpoints are ordered alphabetically in the editor.
|
|
|
To use a REST API endpoint users need api_permission.
|
First steps
Please visit <site url>/v3/swagger/editor.spr URL for a built-in API tester.
First, authentication is needed to use any API endpoint, click Authorize and provide username and password.
After authentication, any API endpoints can be used. To see the available API endpoints, click the group names.
In order to execute an API request, click Try it out.
Set an ID of your Tracker Item and click Execute.
After the execution, a Curl example of the request is displayed, besides the response.
In case of the ID of Tracker Item is invalid, a 404 error code and an error message in the response is returned.
Examples are also provided for complex API requests.
