Tags: API swagger Working Sets

List Working-Sets

Since Codebeamer release 2.0 (HUSKY), a new endpoint is available in Swagger to list information on working-sets based on tracker ID or branch ID:

GET/v3/trackers/{trackerId}/working-sets

Usage

To list working-sets,

Use the GET/v3/trackers/{trackerId}/working-sets endpoint in Swagger.
Add the tracker or branch ID of the relevant tracker to the trackerID field.
The usage of the includeDeleted field is optional.
- If set to -- or to false , information on trackers deleted from the working-set are not listed in the response .
- If set to true, information is displayed even on the deleted trackers, if any, in the response.
Click Execute.

[!listWorkingSetsBranchId.png#d8bdb02c6adabf2558e0322cd2c04381!]

In the Server response section, Code 200 is displayed, that is, the API call has been executed successfully.

The Response body contains the following information about the listed trackers:

Property	Description
`"deleted"`	If `false`, the tracker is not deleted from the working-set. If `true`, the tracker has been deleted from the working-set but is listed in the response as the `includeDeleted` field is set to `true`.
`"createdAt"`	The date of tracker creation.
`"createdBy"`	Lists the ID, name, type and email address of the user who the working-set was created by.
`"workingSet"`	Lists the ID, name and type of the working-set the tracker is included in.
`"sharedInWorkingSet"`	Shows whether the tracker is shared or not in the working-set.
`"branch"`	The branch of the relevant tracker.
`"baseline"`	The baseline of the relevant tracker.

Fast Links

codebeamer Overview
What is new?
How-to videos

codebeamer Knowledge Base
User's Guide (user manual)
Administrator's Guide
Installation Guide
Developer's Guide
Localization Guide

Services by Intland Software
Product Support
Consulting
Training