Swagger V3 – Tracker-API-Änderungen
Ab Codebeamer 10.0 wird Version 3 der dokumentierten Swagger-API unterstützt. Diese Seite beschreibt die vorgenommenen Änderungen und hilft bei der Migration.
Geänderte APIs 
Die Änderungen für die APIs werden wie folgt beschrieben:
API
Änderungen
GET /tracker/{trackerId}/field.
Dieser Endpunkt listet jetzt die Felder des Trackers auf. Den Tracker-Feldern wird ein neues Attribut trackerItemField hinzugefügt.
GET {trackerURI}/roles/permissions.
GET {trackerURI}{roleURI}/permissions / GET {roleURI}{trackerURI}/permissions.
GET {trackerURI}{userURI}/permissions / GET {userURI}{trackerURI}/permissions.
Die folgenden Endpunkte werden mit diesem durch Abfrageparameter erweiterten Endpunkt GET /trackers/{trackerId}/permissions[?query] zusammengeführt.
Verschiedenes 
Modelländerungen
Tracker-Feld-Listenmodell (trackerItemField hinzugefügt)
Der Zweck des Attributs trackerItemField ist es, den genauen Namen eines Tracker-Felds anzuzeigen, das während der Aktualisierung oder Erstellung eines Tracker-Eintrags verwendet wird.
In diesem Beispiel wird das Feld priority Business Value genannt. Dieses Feld oder dieser Name kann sich in anderen Trackern unterscheiden, aber das trackerItemField löst dieses Problem.
[
{
"id": 0,
"name": "ID",
"type": "IntegerField",
"hidden": false,
"valueModel": "IntegerFieldValue"
},
{
"id": 2,
"name": "Business Value",
"type": "OptionChoiceField",
"hidden": false,
"valueModel": "ChoiceFieldValue",
"title": "BV",
"multipleValues": false,
"options": [
{
"id": 1,
"name": "Must have",
"type": "ChoiceOptionReference"
},
{
"id": 3,
"name": "Should have",
"type": "ChoiceOptionReference"
},
{
"id": 5,
"name": "Nice to have",
"type": "ChoiceOptionReference"
}
],
"trackerItemField": "priority",
"referenceType": "ChoiceOptionReference"
},
{
"id": 3,
"name": "Summary",
"type": "TextField",
"hidden": false,
"valueModel": "TextFieldValue",
"trackerItemField": "name"
},
...
]
Berechtigungen aufgelistet nach Rollenmodell
Das beschriebene Modell wird im Endpunkt GET /trackers/{trackerId}/permissions[?query] verwendet, ähnlich dem Ergebnis, das für den Endpunkt GET {trackerURI}/roles/permissions zurückgegeben wird.
",
"title": "BV",
"multipleValues": false,
"options": [
{
"id": 1,
"name": "Must have",
"type": "ChoiceOptionReference"
},
{
"id": 3,
"name": "Should have",
"type": "ChoiceOptionReference"
},
{
"id": 5,
"name": "Nice to have",
"type": "ChoiceOptionReference"
}
],
"trackerItemField": "priority",
"referenceType": "ChoiceOptionReference"
},
{
"id": 3,
"name": "Summary",
"type": "TextField",
"hidden": false,
"valueModel": "TextFieldValue",
"trackerItemField": "name"
},

]
War dies hilfreich?