Since Codebeamer release 2.0 (HUSKY), a new endpoint is available in Swagger to get project-level information on a working-set:
GET/v3/projects/{projectId}/working-sets
All top-level working-sets are returned based on the provided project ID.
Children working-sets are not listed in the response.
Usage
To get project-level working-set information,
- Use the GET/v3/projects/{projectId}/working-sets endpoint in Swagger.
- Add the project ID to the projectId field.
- The usage of the includeDeleted field is optional.
- If set to -- or to false , working-sets deleted from the project are not listed in the response .
- If set to true, even the deleted working-sets, if any, are displayed in the response.
- Click Execute.
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 top-level working-sets:
Property |
Description |
"id"
|
The ID of the working-set. |
"name"
|
The name of the working-set. |
"type"
|
The type of the working-set. |
"createdAt"
|
The date of working-set creation. |
"deleted"
|
If false, the working-set is not deleted from the project.
If true, the working-set has been deleted from the project but is listed in the response as the includeDeleted field is set to true.
|