Tags: API swagger Working Sets

Working-Set Information

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

GET/v3/working-sets/{workingSetId}

The parent-child hierarchy is returned as well in the response.

Usage

To get information on a working-set based on working-set ID,

Use the GET/v3/working-sets/{workingSetId} endpoint in Swagger.
Add the working-set ID to the workingSetId 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.

[!workingSetId.png#8619c035496475c8af9f2eb149621c3f!]

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 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`.
`"project"`	Lists the ID, name and type of the project.
`"createdBy"`	Lists the ID, name, type and email address of the user who the working-set was created by.
`"children"`	Lists the ID, name and type of the children working-sets, if any.

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