uip-tm-Anforderungen

Syntax und Optionen für „uip tm requirements“, das Anforderungen innerhalb eines Test Manager-Projekts verwaltet: Erstellen, Lesen, Aktualisieren, Löschen, Exportieren und Verknüpfen mit Testfällen.

uip tm requirements verwaltet Anforderungen innerhalb eines Test Manager-Projekts. Anforderungen sind die Rückverfolgbarkeitsebene: Sie drücken aus, was das System tun muss, und jede Anforderung kann mit einem oder mehreren Testfällen verknüpft werden, um die Abdeckung anzuzeigen. Sie können Anforderungen manuell erstellen oder über einen externen ALM-Connector (Application Lifecycle Management) (z. B. Jira) synchronisieren, wenn er im Test Manager konfiguriert ist.

Zusammenfassung

uip tm requirements list --project-key <key> [--filter <text>] [--requirement-ids <ids...>] [--labels <labels...>] [--updated-by <userId>] [--test-case-id <uuid>] [--changed-since <datetime>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm requirements get --project-key <key> (--requirement-id <uuid> | --requirement-key <key>)
uip tm requirements create --project-key <key> --name <name> [--description <text>] [--container-id <uuid>] [--external-reference <ref>] [--connector-requirement-uuid <uuid>]
uip tm requirements update --project-key <key> --requirement-id <uuid> [--name <name>] [--description <text>]
uip tm requirements delete --project-key <key> --requirement-ids <uuid...> -y
uip tm requirements export --project-key <key> --output-file <path> [--requirement-ids <uuid...>] [--updated-by <userId>] [--test-case-id <uuid>] [--labels <label...>] [--filter <text>] [--sort-by <expr>]
uip tm requirements list-testcase-ids --project-key <key> --requirement-id <uuid>
uip tm requirements testcases --project-key <key> --requirement-id <uuid> (--add-testcase-ids <uuid...> | --remove-testcase-ids <uuid...>)
uip tm requirements list-by-test-execution --project-key <key> --execution-id <uuid> [--labels <label...>] [--updated-by <userId>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]

Alle Verben berücksichtigen die globalen Optionen und die Standardaustrittscodes. Jedes Verb akzeptiert --log-level <level> (Standard: Information).

UIP-TM-Anforderungsliste

Listen Sie Anforderungen in einem Projekt mit umfangreicher serverseitiger Filterung auf. Die CLI wählt den spezifischsten Backend-Endpunkt basierend auf den bereitgestellten Filter-Flags aus – ein Filter, der nur eine Beschriftung enthält, verwendet einen Schnellpfad; Beim Kombinieren von Beschriftungen mit anderen Filtern wird der Rich-Filter-Endpunkt verwendet.

Argumente

Keine.

Optionen

Markieren	Beschreibung
--project-key <key>	Erforderlich. Aufzulistendes Projekt.
--filter <text>	Suchen Sie Anforderungen anhand des Namens oder Schlüssels.
--requirement-ids <uuid...>	Durch Leerzeichen getrennte UUIDs. Leitet durch den Rich-Filter-Endpunkt weiter.
--labels <labels...>	Durch Leerzeichen getrennte Beschriftungsnamen, nach denen gefiltert werden soll. Wenn sie allein bereitgestellt wird, wird ein Schnellpfad nur für Beschriftungen verwendet.
--updated-by <userId>	Filtern Sie nach der Benutzer-ID, die die Anforderung zuletzt aktualisiert hat.
--test-case-id <uuid>	Nur Anforderungen zurückgeben, die mit dieser Testfall-UUID verknüpft sind.
--changed-since <datetime>	Rückgabeanforderungen, die nach diesem ISO-8601-Zeitstempel geändert wurden.
--sort-by <expr>	Sortierausdruck (Feldname, optional mit :asc oder :desc angehängt).
--limit <n>	Seitengröße. Die Standardeinstellung ist 50.
--offset <n>	Ergebnisse, die übersprungen werden sollen. Die Standardeinstellung ist 0.

Beispiel

uip tm requirements list \
  --project-key DEMO \
  --labels "high-priority" \
  --limit 20

Datenform

{
  "Code": "RequirementsList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjKey": "DEMO:1",
      "ProjectId": "00000000-0000-0000-0000-000000000abc",
      "Name": "User must be able to log in",
      "Description": "Login with valid credentials succeeds",
      "ContainerId": "c1c2c3c4-0000-0000-0000-000000000001",
      "ConnectorRequirementId": "ext-req-42",
      "ForeignReference": "JIRA-100",
      "CustomFieldLabels": { "Tags": ["smoke", "auth"] },
      "CustomFieldValues": { "Owner": "qa-team" },
      "Created": "2025-04-15T10:30:00Z",
      "CreatedBy": "11111111-2222-3333-4444-555555555555",
      "Updated": "2025-04-15T10:30:00Z",
      "UpdatedBy": "11111111-2222-3333-4444-555555555555"
    }
  ]
}

Wichtige Felder: ObjKey – Verwendung in --requirement-key auf get. Id – Verwendung in --requirement-id auf get, update, delete, list-testcase-ids und testcases. ForeignReference – festgelegt über --external-reference in create.

UIP-TM-Anforderungen abrufen

Rufen Sie eine einzelne Anforderung mithilfe ihrer internen UUID oder ihres PROJECT:N -Schlüssels ab. Übergeben Sie entweder --requirement-id oder --requirement-key – sie schließen sich gegenseitig aus.

Argumente

Keine.

Optionen

Markieren	Beschreibung
--project-key <key>	Erforderlich. Besitz des Projekts.
--requirement-id <uuid>	UUID der internen Anforderung. Sich gegenseitig mit --requirement-key ausschließen.
--requirement-key <key>	Anforderungsschlüssel (z. B. DEMO:1). Sich gegenseitig mit --requirement-id ausschließen.

Beispiel

uip tm requirements get \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001

Datenform

{
  "Code": "RequirementGet",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjKey": "DEMO:1",
    "Name": "User must be able to log in",
    "Description": "Login with valid credentials succeeds",
    "ForeignReference": "JIRA-100"
  }
}

uip-tm-Anforderungen erstellen

Erstellen Sie eine neue Anforderung in einem Projekt.

Argumente

Keine.

Optionen

Markieren	Beschreibung
--project-key <key>	Erforderlich. Besitz des Projekts.
--name <name>	Erforderlich. Anforderungsname.
--description <text>	Freiform-Beschreibung. Standardmäßig leer.
--container-id <uuid>	Container-UUID, in der die Anforderung platziert werden soll (optional).
--external-reference <ref>	Externes Systemreferenz (z. B. eine Jira-Ticket-ID).
--connector-requirement-uuid <uuid>	UUID aus einem verbundenen externen Anforderungssystem. Muss eine gültige UUID sein.

Beispiel

uip tm requirements create \
  --project-key DEMO \
  --name "User must be able to log in" \
  --external-reference "JIRA-123"

Datenform

{
  "Code": "RequirementCreate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjKey": "DEMO:1",
    "Name": "User must be able to log in",
    "ForeignReference": "JIRA-100"
  }
}

Aktualisierung der UIP-TM-Anforderungen

Aktualisieren Sie eine vorhandene Anforderung. Mindestens eines dieser Felder muss ausgefüllt werden.

Argumente

Keine.

Optionen

Markieren	Beschreibung
--project-key <key>	Erforderlich. Besitz des Projekts.
--requirement-id <uuid>	Erforderlich. Interne UUID der zu aktualisierenden Anforderung.
--name <name>	Neuer Name.
--description <text>	Neue Beschreibung.

Beispiel

uip tm requirements update \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --name "User must be able to log in with MFA"

Datenform

{
  "Code": "RequirementUpdate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "User must be able to log in with MFA",
    "Result": "Updated"
  }
}

UIP-TM-Anforderungen löschen

Löschen Sie eine oder mehrere Anforderungen. -y/--yes ist erforderlich – die CLI fordert nie interaktiv auf. Eine einzelne UUID und mehrere UUIDs durchlaufen beide denselben Massenendpunkt.

Argumente

Keine.

Optionen

Markieren	Beschreibung
--project-key <key>	Erforderlich. Besitz des Projekts.
--requirement-ids <uuid...>	Erforderlich. Zu löschende Anforderungs-UUIDs (durch Leerzeichen getrennt).
-y, --yes	Erforderlich. Bestätigen Sie diesen nicht rückgängig zu machenden Vorgang.

Beispiele

# Delete a single requirement
uip tm requirements delete \
  --project-key DEMO \
  --requirement-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --yes

# Delete multiple requirements in one call
uip tm requirements delete \
  --project-key DEMO \
  --requirement-ids a1b2c3d4-0000-0000-0000-000000000001 b2c3d4e5-0000-0000-0000-000000000001 \
  --yes

Datenform

{
  "Code": "RequirementDelete",
  "Data": { "Passed": 2, "Failed": 0 }
}

Export von UIP-TM-Anforderungen

Exportanforderungen in eine .xlsx -Datei. Unterstützt dieselben Filter-Flags wie requirements list.

Argumente

Keine.

Optionen

Markieren	Beschreibung
--project-key <key>	Erforderlich. Besitz des Projekts.
--output-file <path>	Erforderlich. Pfad zum Schreiben der Exportdatei.
--requirement-ids <uuid...>	Filtern Sie nach Anforderungs-UUIDs.
--updated-by <userId>	Filtern Sie nach der Benutzer-ID, die die Anforderung zuletzt aktualisiert hat.
--test-case-id <uuid>	Filtern Sie nach der UUID des verknüpften Testfalls.
--labels <label...>	Nach Kennzeichnungen filtern.
--filter <text>	Suchen Sie anhand des Namens oder Schlüssels.
--sort-by <expr>	Ergebnisse sortieren.

Beispiel

uip tm requirements export \
  --project-key DEMO \
  --output-file ./requirements-export.xlsx

Datenform

{
  "Code": "RequirementExport",
  "Data": { "OutputFile": "./requirements-export.xlsx", "Bytes": 1024, "Result": "Exported" }
}

UIP-TM-Anforderungsliste-Testfall-IDs

Listen Sie die UUIDs der Testfälle auf, die mit einer Anforderung verknüpft sind.

Argumente

Keine.

Optionen

Markieren	Beschreibung
--project-key <key>	Erforderlich. Besitz des Projekts.
--requirement-id <uuid>	Erforderlich. Interne UUID der Anforderung.

Beispiel

uip tm requirements list-testcase-ids \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001

Datenform

{
  "Code": "RequirementTestCaseIdsList",
  "Data": { "TestCaseIds": ["b2c3d4e5-0000-0000-0000-000000000001", "c3d4e5f6-0000-0000-0000-000000000001"] }
}

Testfälle für UIP-TM-Anforderungen

Fügen Sie Testfalllinks für eine Anforderung hinzu oder entfernen Sie sie. Übergeben Sie entweder --add-testcase-ids oder --remove-testcase-ids (nicht beide im selben Aufruf).

Argumente

Keine.

Optionen

Markieren	Beschreibung
--project-key <key>	Erforderlich. Besitz des Projekts.
--requirement-id <uuid>	Erforderlich. Änderungsanforderung.
--add-testcase-ids <uuid...>	Durch Leerzeichen getrennte Testfall-UUIDs, die verknüpft werden sollen.
--remove-testcase-ids <uuid...>	Durch Leerzeichen getrennte Testfall-UUIDs, deren Verknüpfung aufgehoben werden soll.

Beispiele

# link test cases
uip tm requirements testcases \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --add-testcase-ids b2c3d4e5-0000-0000-0000-000000000001 c3d4e5f6-0000-0000-0000-000000000001

# unlink test cases
uip tm requirements testcases \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --remove-testcase-ids b2c3d4e5-0000-0000-0000-000000000001

Datenform – Anhängen

{ "Code": "RequirementAssignTestCases", "Data": { "Id": "a1b2c3d4-...", "Assigned": 2, "Result": "Assigned" } }

Datenform – trennen

{ "Code": "RequirementUnassignTestCases", "Data": { "Id": "a1b2c3d4-...", "Unassigned": 1, "Result": "Unassigned" } }

Liste der UIP-TM-Anforderungen nach Testausführung

Listen Sie die Anforderungen auf, die von einer bestimmten Testausführung abgedeckt werden. Gibt die Anforderungen zurück, deren verknüpfte Testfälle in dieser Ausführung enthalten waren.

Argumente

Keine.

Optionen

Markieren	Beschreibung
--project-key <key>	Erforderlich. Besitz des Projekts.
--execution-id <uuid>	Erforderlich. UUID für die Testausführung.
--labels <label...>	Filtern Sie nach Beschriftungsnamen ( durch Leerzeichen getrennt).
--updated-by <userId>	Filtern Sie nach der Benutzer-ID, die die Anforderung zuletzt aktualisiert hat.
--filter <text>	Suchen Sie Anforderungen anhand des Namens oder Schlüssels.
--sort-by <expr>	Sortierausdruck (Feldname, optional mit :asc oder :desc angehängt).
--limit <n>	Seitengröße. Die Standardeinstellung ist 50.
--offset <n>	Ergebnisse, die übersprungen werden sollen. Die Standardeinstellung ist 0.

Beispiel

uip tm requirements list-by-test-execution \
  --project-key DEMO \
  --execution-id b2c3d4e5-0000-0000-0000-000000000001

Datenform

{
  "Code": "RequirementsListByTestExecution",
  "Data": [{ "Id": "a1b2c3d4-0000-0000-0000-000000000001", "ObjKey": "DEMO:1", "Name": "User must be able to log in" }]
}

Zugehörig

• project – besitzender Projekt-Scope.
• Testfälle – Testfälle, die mit Anforderungen verknüpft werden können.
• Ausführungen – Quelle des --execution-id der von list-by-test-execution verwendet wird.

Siehe auch

• Test Manager-Übersicht