Swagger V3 Working Set API Changes
The new V3 version of our Swagger documented API has been introduced with the release of Codebeamer 10.0. The purpose of this page to describe the changes made and help users with the migration.
Endpoint Changes
Codebeamer Release 2.0 (HUSKY)
In Codebeamer release 2.0 (HUSKY), a new endpoint has been introduced for updating either all the branches of a working set, or only the branches created from a selected list of trackers:
POST /v3/workingset/{id}/permission
 |
Notes:
• This endpoint updates only the selected trackers (branches), shared trackers are not considered.
• The user must have a Working Set - Admin permission on the target project.
• Only the roles specified in the payload are updated by this endpoint. In case of other roles, the permissions are unchanged.
• The Project Admin permission cannot be updated.
• Invalid permission configurations cannot be configured. For example, when the user tries to set Mass-Edit Permission without setting the View Permission, the configuration is ignored.
|
Request body format:
{
"trackers": [],
"permissions": [],
"roles": []
}
"trackers": [],
"permissions": [],
"roles": []
}
Example:
"trackers": [
{
"id": 7659,
"name": "Bugs",
"type": "TrackerReference"
},
{
"id": 3458,
"name": "Tasks",
"type": "TrackerReference"
}
],
"roles": [
{
"id": 14,
"name": "Project Admin",
"type": "RoleReference"
},
{
"id": 11,
"name": "Developer",
"type": "RoleReference"
}
],
"permissions": [
{
"id": 1,
"name": "Item - View if Owner",
"type": "TrackerPermissionReference"
},
{
"id": 2,
"name": "Item - Edit if Owner",
"type": "TrackerPermissionReference"
}
]
}
{
"id": 7659,
"name": "Bugs",
"type": "TrackerReference"
},
{
"id": 3458,
"name": "Tasks",
"type": "TrackerReference"
}
],
"roles": [
{
"id": 14,
"name": "Project Admin",
"type": "RoleReference"
},
{
"id": 11,
"name": "Developer",
"type": "RoleReference"
}
],
"permissions": [
{
"id": 1,
"name": "Item - View if Owner",
"type": "TrackerPermissionReference"
},
{
"id": 2,
"name": "Item - Edit if Owner",
"type": "TrackerPermissionReference"
}
]
}