Beispiel für Tracker-Feldinformationen
In diesem Thema werden Beispiele für Tracker-Feldinformationen veranschaulicht.
Felder eines Trackers abrufen
Dieser Endpunkt gibt Referenzen der konfigurierten Felder in einem Tracker zurück.
URL
GET /v3/trackers/{trackerId}/fields
Beispiel für Antworttext
[
{
"id": 0,
"name": "ID",
"type": "FieldReference",
"trackerId": 4307
},
{
"id": 1,
"name": "Tracker",
"type": "FieldReference",
"trackerId": 4307
},
{
"id": 2,
"name": "Priority",
"type": "FieldReference",
"trackerId": 4307
},
{
"id": 3,
"name": "Name",
"type": "FieldReference",
"trackerId": 4307
},
...
]
{
"id": 0,
"name": "ID",
"type": "FieldReference",
"trackerId": 4307
},
{
"id": 1,
"name": "Tracker",
"type": "FieldReference",
"trackerId": 4307
},
{
"id": 2,
"name": "Priority",
"type": "FieldReference",
"trackerId": 4307
},
{
"id": 3,
"name": "Name",
"type": "FieldReference",
"trackerId": 4307
},
...
]
Detaillierte Informationen zu einem Feld in einem bestimmten Tracker abrufen
Dieser Endpunkt gibt detaillierte Informationen zu einem bestimmten Feld zurück.
URL
GET /v3/trackers/{trackerId}/fields/{fieldId}
Ausgabeparameter
|
Parameter
|
Beschreibung
|
|---|---|
|
id
|
ID des Felds. Sie kann verwendet werden, um ein Feld zu identifizieren. Beispielsweise für Wertänderungen.
|
|
name
|
Name des Felds.
|
|
description
|
Beschreibung des Felds.
|
|
type
|
|
|
hidden
|
Indikator für ausgeblendete Felder.
|
|
valueModel
|
Der Name des Modells, der im Falle von Wertänderungen angegeben werden muss.
|
|
mandatoryInStatuses
|
Liste der Statusoptionen, bei denen der Feldwert in einem Tracker-Eintrag festgelegt werden muss.
|
|
multipleValues
|
Indikator für das Folgen mehrerer Werte für ein Auswahlfeld.
|
|
options
|
Liste der Optionen für ein Auswahloptionsfeld.
|
|
trackerItemField
|
Indikator für integrierte Felder (das Feld wird in allen Trackern gemeinsam verwendet). Gibt an, wo im TrackerItem-Modell Sie das Feld setzen können.
|
|
referenceType
|
Indikator für den Typ der Referenzen, die von Auswahlfeldern akzeptiert werden.
Beispiel:
• ChoiceOptionReference für Auswahlfelder.
• TrackerItemReference für Referenzfelder für Tracker-Einträge.
|
Beispiel für Antworttext
{
"id": 14,
"name": "Severity",
"description": "VoCA (Voice of Customer Audit)",
"type": "OptionChoiceField",
"hidden": false,
"valueModel": "ChoiceFieldValue",
"mandatoryInStatuses": [
{
"id": 0,
"name": "Unset",
"type": "ChoiceOptionReference"
},
{
"id": 3,
"name": "New / Unassigned",
"type": "ChoiceOptionReference"
},
{
"id": 5,
"name": "In Verification",
"type": "ChoiceOptionReference"
},
{
"id": 7,
"name": "Closed",
"type": "ChoiceOptionReference"
},
{
"id": 8,
"name": "Open In Domain",
"type": "ChoiceOptionReference"
}
],
"multipleValues": false,
"options": [
{
"id": 0,
"name": "Unset",
"type": "ChoiceOptionReference"
},
{
"id": 1,
"name": "VoCA Prio 1",
"type": "ChoiceOptionReference"
},
{
"id": 2,
"name": "VoCA Prio 2",
"type": "ChoiceOptionReference"
},
{
"id": 7,
"name": "Not Applicable",
"type": "ChoiceOptionReference"
}
],
"trackerItemField": "severities",
"referenceType": "ChoiceOptionReference"
},
"id": 14,
"name": "Severity",
"description": "VoCA (Voice of Customer Audit)",
"type": "OptionChoiceField",
"hidden": false,
"valueModel": "ChoiceFieldValue",
"mandatoryInStatuses": [
{
"id": 0,
"name": "Unset",
"type": "ChoiceOptionReference"
},
{
"id": 3,
"name": "New / Unassigned",
"type": "ChoiceOptionReference"
},
{
"id": 5,
"name": "In Verification",
"type": "ChoiceOptionReference"
},
{
"id": 7,
"name": "Closed",
"type": "ChoiceOptionReference"
},
{
"id": 8,
"name": "Open In Domain",
"type": "ChoiceOptionReference"
}
],
"multipleValues": false,
"options": [
{
"id": 0,
"name": "Unset",
"type": "ChoiceOptionReference"
},
{
"id": 1,
"name": "VoCA Prio 1",
"type": "ChoiceOptionReference"
},
{
"id": 2,
"name": "VoCA Prio 2",
"type": "ChoiceOptionReference"
},
{
"id": 7,
"name": "Not Applicable",
"type": "ChoiceOptionReference"
}
],
"trackerItemField": "severities",
"referenceType": "ChoiceOptionReference"
},
Berechtigungseinstellungen für ein Tracker-Feld abrufen
Dieser Endpunkt gibt die Status-, Rollen- oder Berechtigungsmatrix eines bestimmten Felds zurück.
URL
GET /v3/trackers/{trackerId}/fields/{fieldId}/permissions
Codebeamer Benutzeroberfläche
Beispiel für Antworttext
[
{
"status": {
"id": 0,
"name": "Unset",
"type": "ChoiceOptionReference"
},
"permissions": [
{
"role": {
"id": 1,
"name": "Project Admin",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "READ"
},
{
"role": {
"id": 2,
"name": "Developer",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "READ"
},
...
]
},
{
"status": {
"id": 1,
"name": "New",
"type": "ChoiceOptionReference"
},
"permissions": [
{
"role": {
"id": 1,
"name": "Project Admin",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "WRITE"
},
{
"role": {
"id": 2,
"name": "Developer",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "WRITE"
},
...
},
{
"status": {
"id": 2,
"name": "Verified",
"type": "ChoiceOptionReference"
},
"permissions": [ ... ]
},
{
"status": {
"id": 3,
"name": "In progress",
"type": "ChoiceOptionReference"
},
"permissions": [ ... ]
},
...
]
{
"status": {
"id": 0,
"name": "Unset",
"type": "ChoiceOptionReference"
},
"permissions": [
{
"role": {
"id": 1,
"name": "Project Admin",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "READ"
},
{
"role": {
"id": 2,
"name": "Developer",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "READ"
},
...
]
},
{
"status": {
"id": 1,
"name": "New",
"type": "ChoiceOptionReference"
},
"permissions": [
{
"role": {
"id": 1,
"name": "Project Admin",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "WRITE"
},
{
"role": {
"id": 2,
"name": "Developer",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "WRITE"
},
...
},
{
"status": {
"id": 2,
"name": "Verified",
"type": "ChoiceOptionReference"
},
"permissions": [ ... ]
},
{
"status": {
"id": 3,
"name": "In progress",
"type": "ChoiceOptionReference"
},
"permissions": [ ... ]
},
...
]
Übergeordnetes Thema