Swagger V3 Tracker Configuration Endpoints

Since Codebeamer release 2.1 (IMPALA), the following Tracker Configuration endpoints are available:

• Get Tracker Configuration - GET/v3/tracker/{trackerId}/configuration
• Create or Update Tracker Configuration - POST/v3/tracker/configuration

Get Tracker Configuration

Based on the trackerId the Get Tracker Configuration endpoint returns the settings of the General and the Fields tabs in the Configuration menu of a given tracker on the User Interface.

GET/v3/tracker/{trackerId}/configuration

Usage

To get the tracker configuration settings of the General and the Fields tabs,

1. Use the GET/v3/tracker/{trackerId}/configuration endpoint in Swagger.
2. Provide the trackerId.
3. Click Execute.

Code 200 in the Server response section confirms that the API request has been executed successfully.

In the Response body, all the tracker configuration settings of the General and Fields tabs on the User Interface are returned in JSON format.

Create or Update Tracker Configuration

Using the Create or Update Tracker Configuration endpoint, the settings of the General and the Fields tabs in the Configuration menu of a tracker can be managed.

POST/v3/tracker/configuration

The POST/v3/tracker/configuration endpoint allows the modification of all configuration settings of the General and Fields tabs of the tracker configuration in JSON format.

Always double-check the accuracy and necessity of the changes you are about to perform to avoid configuration errors.

Usage

To create or update the configurations of trackers,

1. Use the POST/v3/tracker/configuration endpoint in Swagger.
2. Get the General and Fields configuration settings of the relevant tracker by using the GET/v3/tracker/{trackerId}/configuration.
3. Copy the JSON from the Response body.
4. Paste the JSON to the Request body of the POST/v3/tracker/configuration endpoint.
5. Perform the necessary configuration changes by modifying the JSON.
6. Click Execute.

Code 200 in the Server response section confirms that the amended tracker configuration changes are saved.

Operation

With the POST/v3/tracker/configuration endpoint,

• Existing tracker configurations can be changed,
• New trackers can be created with the same General and Fields configuration settings as the source tracker, or with modified settings.

Using the tracker configuration JSON of a tracker as a source, deleting its "trackerId" and clicking Execute, a new tracker is created having the same General and Fields configuration settings as the source tracker. Go back to the User Interface, reload the page and the newly created tracker is displayed.

In case a non-existing "trackerId" is provided in the JSON, the API request fails.

Once the changes are performed, click Execute and reload the User Interface to synchronize the changes.