Benutzerdefinierte Felder

Benutzerdefinierte Felder in Requirements & Systems Portal - API-Dokumentation

Einführung

In Requirements & Systems Portal bieten benutzerdefinierte Felder eine leistungsstarke Möglichkeit, die Funktionalität der Plattform zu erweitern, indem Benutzer zusätzliche Felder erstellen können, die Anforderungen und Testläufen zugeordnet sind. Diese Felder können verschiedene Datentypen speichern, z. B. Datumswerte, Text und Auswahlen. Diese API-Dokumentation beschreibt den Prozess zum programmgesteuerten Erstellen, Aktualisieren und Verwalten von benutzerdefinierten Feldern und deren Optionen.

Definition benutzerdefinierter Felder

Benutzerdefinierte Felder in Requirements & Systems Portal können über den Endpunkt /data/custom-field/ mit der folgenden Syntax erstellt werden:

CustomField{
  "projects": [uniqueItems: true integer],
  "target_content_type": integer,
  "name": string,
  "type": integer,
  "multi": boolean
}

• projects: Liste der eindeutigen Projektkennungen, in denen das benutzerdefinierte Feld verfügbar sein soll.

• target_content_type: Der Ziel-Content-Typ für das benutzerdefinierte Feld. Verwenden Sie 120 für Anforderungen und 291 für Testläufe.

• name: Der Name des benutzerdefinierten Feldes.

• type: Verwenden Sie 0 für Text, 1 für Auswahl und 2 für Datum.

• multi: Auf true setzen für Mehrfachauswahl bei der Definition eines Auswahltyps.

Benutzerdefinierte Felder erstellen

Um ein benutzerdefiniertes Feld zu erstellen, verwenden Sie die PUT-Methode für den Endpunkt /data/custom-field/. Zum Beispiel:

{
  "projects": [136],
  "target_content_type": 120,
  "name": "New Selection Column",
  "type": 1
}

Definition von Optionen für benutzerdefinierte Felder

Beim Erstellen benutzerdefinierter Felder vom Typ Auswahl müssen Sie auch die verfügbaren Optionen über den Endpunkt /data/custom-field-options/ mit dem folgenden Modell definieren:

CustomFieldOption{
  "custom_field": integer,
  "titlename": string,
  "position": number
}

• custom_field: Die eindeutige Kennung des benutzerdefinierten Feldes, für das die Option erstellt wird.

• titlename: Der Name der Option.

• position: Optionales Feld zur Definition der Position der Option in der Optionsliste.

Optionen für benutzerdefinierte Felder erstellen

Um eine Option für ein benutzerdefiniertes Feld zu erstellen, verwenden Sie die PUT-Methode für den Endpunkt /data/custom-field-options/. Zum Beispiel:

{
  "custom_field": 58,
  "name": "New Option"
}

Daten zu benutzerdefinierten Feldern hinzufügen

Um Daten zu einem benutzerdefinierten Feld hinzuzufügen, verwenden Sie den Endpunkt /data/custom-field-row/ mit dem folgenden Modell:

CustomFieldRow{
  "referenced_object_id": integer,
  "custom_field": integer,
  "value": string
}

• referenced_object_id: Die eindeutige Kennung des Objekts (Anforderung oder Testlauf), zu dem die Daten gehören.

• custom_field: Die eindeutige Kennung des benutzerdefinierten Feldes, zu dem die Daten hinzugefügt werden.

• value: Die hinzuzufügenden Daten. Für Text verwenden Sie eine Freitextzeichenfolge; für Einzelauswahl verwenden Sie eine Options-ID; für Mehrfachauswahl verwenden Sie eine Liste von Options-IDs; für Datum verwenden Sie ein Datum im Zeichenfolgenformat.

Daten zu benutzerdefinierten Feldern hinzufügen – erstmalige Eingabe

Für die erstmalige Eingabe von Daten in ein benutzerdefiniertes Feld eines bestimmten Objekts verwenden Sie die POST-Methode für den Endpunkt /data/custom-field-row/bulk-create/. Zum Beispiel:

{
  "referenced_object_id": 33803,
  "custom_field": 58,
  "value": 29
}

Daten in benutzerdefinierten Feldern aktualisieren

Um vorhandene Daten für ein benutzerdefiniertes Feld eines bestimmten Objekts zu aktualisieren, verwenden Sie die POST-Methode für den Endpunkt /data/custom-field-row/bulk-update/. Zum Beispiel:

{
  "614": {
    "value": 30
  }
}

Daten aus benutzerdefinierten Feldern entfernen

Um Daten zu entfernen, die einem bestimmten benutzerdefinierten Feld und Objekt zugeordnet sind, verwenden Sie dieselbe Bulk-Update-Methode mit "value": null. Zum Beispiel:

{
  "614": {
    "value": null
  }
}

Fazit

Benutzerdefinierte Felder in Requirements & Systems Portal ermöglichen es Ihnen, die Funktionen der Plattform zu erweitern und sie an die spezifischen Anforderungen Ihres Projekts anzupassen. Mithilfe der bereitgestellten API-Endpunkte können Sie benutzerdefinierte Felder erstellen, Optionen definieren und Daten programmgesteuert hinzufügen, wodurch Requirements & Systems Portal zu einem vielseitigen Werkzeug für Ihre Projektmanagement- und Analyseanforderungen wird.