UIP-TM-Objektbeschriftung

Syntax und Optionen für „uip tm objectlabel“, das Beschriftungen verwaltet, die an Test Manager-Objekte wie Testfälle und Anforderungen angehängt sind.

uip tm objectlabel verwaltet Beschriftungen, die an Test Manager-Objekte angehängt sind (Anforderungen, Testfälle, Testsätze, Testausführungen und Testfallprotokolle). Bezeichnungen sind Freiform-Zeichenfolgen, die verwendet werden, um Objekte für die Filterung und Suche mit Tags zu versehen und zu gruppieren.

Wichtig:

--project-key und --object-type sind für jedes Verb in dieser Gruppe erforderlich , einschließlich get. --object-ids und --labels sind durchgängig und durch Leerzeichen getrennt; Die Singularformulare --object-id und --label sind nicht vorhanden.

Zusammenfassung

uip tm objectlabel list --project-key <key> --object-type <type> [--object-ids <uuid...>] [--label-types <types...>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm objectlabel get --project-key <key> --object-type <type> --label-id <uuid>
uip tm objectlabel add --project-key <key> --object-type <type> --object-ids <uuid...> --labels <name...> [--label-type <type>] [--remove-other-labels]
uip tm objectlabel remove --project-key <key> --object-type <type> --object-ids <uuid...> (--labels <name...> | --remove-all-labels) [-y]

Alle Verben berücksichtigen die globalen Optionen und die Standardaustrittscodes. Jedes Verb akzeptiert --log-level <level> (Standardwert Information) und -t, --tenant <name> (Standardwert ist der authentifizierte Mandant).

--object-type akzeptiert Requirement, TestCase, TestSet, TestExecution oder TestCaseLog. --label-type/--label-types akzeptieren die grafischen Werte userLabel, systemLabel, internalLabel – nicht die PascalCase-Formulare, die an anderer Stelle in dieser CLI verwendet werden.

UIP-TM-Objektbeschriftungsliste

Listen Sie verschiedene Beschriftungsnamen auf, die für einen Objekttyp verwendet werden (paginiert). Dadurch werden keine Beschriftungszuweisungszeilen zurückgegeben – verwenden Sie get für das Detail einer einzelnen Zeile.

Argumente

Keine.

Optionen

• --project-key <key> (erforderlich) – besitzendes Projekt.
• --object-type <type> (erforderlich) – Objekttyp, für den Beschriftungen aufgelistet werden sollen.
• --object-ids <uuid...> – auf Beschriftungen beschränken, die diesen Objekten zugewiesen sind (durch Leerzeichen getrennt). Lassen Sie die Suche über den gesamten Objekttyp weg.
• --label-types <type...> – Filtern nach Beschriftungstypen (userLabel, systemLabel, internalLabel, durch Leerzeichen getrennt). Standardmäßig auf userLabel + systemLabel.
• --filter <text> – Präfix zum Abgleich von Beschriftungsnamen mit (serverseitiges StartsWith, keine allgemeine Teilstring-Suche).
• --sort-by <expr> – Sortierausdruck, z. B. name asc.
• --limit <n> – Seitengröße. Die Standardeinstellung ist 50.
• --offset <n> – Ergebnisse, die übersprungen werden sollen. Die Standardeinstellung ist 0.

Beispiel

uip tm objectlabel list \
  --project-key DEMO \
  --object-type TestCase \
  --filter smo \
  --limit 50

Datenform

{
  "Code": "ObjectLabelsList",
  "Data": [
    { "Name": "smoke" },
    { "Name": "smoke-test" }
  ]
}

Jede Zeile ist nur { "Name": "<label>" } – es wird kein Id, ObjectId oder LabelType von list zurückgegeben. Um die vollständigen Details einer bestimmten Zuweisungszeile abzurufen (einschließlich ihrer Id), verwenden Sie objectlabel get.

Abrufen der UIP-TM-Objektbeschriftung

Rufen Sie eine einzelne Beschriftungszuweisungszeile anhand ihrer Zuweisungs-UUID ab.

Argumente

Keine.

Optionen

• --project-key <key> (erforderlich) – besitzendes Projekt.
• --object-type <type> (erforderlich) – Der Objekttyp, zu dem die Beschriftung gehört.
• --label-id <uuid> (erforderlich) – UUID der Zeile der Beschriftungszuweisung. Dies ist die UUID des Zuweisungsdatensatzes, kein Beschriftungsname.

Beispiel

uip tm objectlabel get \
  --project-key DEMO \
  --object-type TestCase \
  --label-id a1b2c3d4-0000-0000-0000-000000000001

Datenform

{
  "Code": "ObjectLabelGet",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "f9e8d7c6-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Name": "smoke",
    "Description": "",
    "LabelType": "UserLabel"
  }
}

LabelType in dieser Antwort ist PascalCase (UserLabel, SystemLabel, InternalLabel), obwohl die Eingabeflags --label-type/--label-types die Binnenform Binnenmajuskel haben.

UIP-TM Object Label Add

Fügen Sie Beschriftungen zu einem oder mehreren Objekten hinzu. Zwei unterschiedliche Verhaltensweisen, je nachdem, ob --label-type übergeben wird:

• Ohne --label-type (Standard): ein einzelner Massenaufruf für alle Objekte und Beschriftungen. Übergeben Sie --remove-other-labels , um dies zu einem autoritativen Satz zu machen – nach dem Hinzufügen werden alle Nicht-System-Beschriftungen für diese Objekte, die sich nicht in --labels befinden, gelöscht.
• Mit --label-type: Jede Beschriftung wird einzeln zugewiesen (Schleife jedes Objekt × Beschriftungspaar), sodass ein bestimmter Beschriftungstyp aufgezeichnet werden kann. --remove-other-labels wird in diesem Modus ignoriert.

Argumente

Keine.

Optionen

• --project-key <key> (erforderlich) – besitzendes Projekt.
• --object-type <type> (erforderlich) – Objekttyp.
• --object-ids <uuid...> (erforderlich) – durch Leerzeichen getrennte Objekt-UUIDs, auf die die Beschriftungen angewendet werden sollen.
• --labels <name...> (erforderlich) – durch Leerzeichen getrennte Beschriftungsnamen.
• --label-type <type> – Beschriftungstyp (userLabel, systemLabel, internalLabel). Wenn diese Option festgelegt ist, wird zum oben beschriebenen Zuweisungspfad pro Paar gewechselt.
• --remove-other-labels – Löschen Sie nach dem Hinzufügen alle Nicht-System-Beschriftungen für diese Objekte, die nicht in --labels vorhanden sind. Wird ignoriert, wenn --label-type festgelegt ist.

Beispiele

# Bulk add — multiple labels to multiple objects in one call
uip tm objectlabel add \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids id1 id2 \
  --labels smoke regression

# With a specific label type — assigns each label individually
uip tm objectlabel add \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids id1 id2 \
  --labels smoke \
  --label-type systemLabel

Datenform

{
  "Code": "ObjectLabelsAdd",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 2,
    "Result": "Added"
  }
}

Wenn --label-type übergeben wird, enthält die Antwort Folgendes:

{
  "Code": "ObjectLabelsAdd",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 1,
    "LabelType": "systemLabel",
    "Result": "Added"
  }
}

UIP-TM-Objektbeschriftung entfernen

Entfernen Sie Beschriftungen von einem oder mehreren Objekten. Dies ist ein unwiderruflicher Vorgang – er erfordert -y, --yes; die CLI fordert nie auf. Geben Sie entweder --labels an, um bestimmte Beschriftungen zu entfernen, oder --remove-all-labels, um jede Nicht-System-Beschriftung aus den angegebenen Objekten zu löschen – die beiden schließen sich gegenseitig aus.

Argumente

Keine.

Optionen

• --project-key <key> (erforderlich) – besitzendes Projekt.
• --object-type <type> (erforderlich) – Objekttyp.
• --object-ids <uuid...> (erforderlich) – durch Leerzeichen getrennte Objekt-UUIDs.
• --labels <name...> – durch Leerzeichen getrennte Beschriftungsnamen, die entfernt werden sollen. Erforderlich, es sei denn, --remove-all-labels ist festgelegt.
• --remove-all-labels – Löschen Sie jede Nicht-System-Beschriftung auf den aufgeführten Objekten. Sich gegenseitig mit --labels ausschließen.
• -y, --yes – bestätigen Sie diesen nicht rückgängig zu machenden Vorgang. Erforderlich – die CLI fordert nie auf.

Beispiele

# remove specific labels
uip tm objectlabel remove \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids id1 id2 \
  --labels regression \
  --yes

# clear every non-system label
uip tm objectlabel remove \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids id1 id2 \
  --remove-all-labels \
  --yes

Datenform

{
  "Code": "ObjectLabelsRemove",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 1,
    "Result": "Removed"
  }
}

Bei --remove-all-labels meldet die Antwort RemoveAllLabels anstelle von LabelCount und Result ist AllRemoved:

{
  "Code": "ObjectLabelsRemove",
  "Data": {
    "ObjectCount": 2,
    "RemoveAllLabels": true,
    "Result": "AllRemoved"
  }
}

Zugehörig

• requirements – Anforderungen können Objektbeschriftungen enthalten.
• customfield – ein separater Beschriftungsmechanismus (customfield label) für benutzerdefinierte Feldwerte des Beschriftungstyps; sich von den Freiform-Tags von objectlabel unterscheidet.

Siehe auch

• Test Manager-Übersicht