Libellé d'objet uip tm

Syntaxe et options de `uip tm objectname`, qui gère les libellés associés aux objets Test Manager tels que les cas et les exigences de test.

uip tm objectlabel gère les libellés attachés aux objets Test Manager (exigences, cas de test, ensembles de test, exécutions de test et journaux des cas de test). Les libellés sont des chaînes de forme libre utilisées pour étiqueter et regrouper des objets à des fins de filtrage et de recherche.

Important :

--project-key et --object-type sont requis sur chaque verbe de ce groupe, y compris get --object-ids et --labels sont au maximum et séparés par des espaces; les formulaires singulaires --object-id et --label n'existent pas.

Synthèse

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]

Tous les verbes respectent les options globales et les codes de sortie standard. Chaque verbe accepte --log-level <level> (par défaut Information) et -t, --tenant <name> (par défaut au locataire authentifié).

--object-type accepte Requirement, TestCase, TestSet, TestExecution ou TestCaseLog. --label-type/--label-types acceptent les valeurs de forme fil de userLabel, systemLabel, internalLabel — et non les formulaires PascalCase utilisés ailleurs dans cette CLI.

liste des libellés d'objets uip tm

Répertorie les noms de libellé distincts utilisés pour un type d’objet (paginé). Cela ne renvoie pas les lignes d’affectation de libellé — utilisez get pour le détail d’une seule ligne.

Arguments

Aucun

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet pour lequel lister les libellés.
• --object-ids <uuid...> — restreindre aux libellés attribués à ces objets (séparés par des espaces). Omettez à rechercher sur l'ensemble du type d'objet.
• --label-types <type...>: filtrer par types de libellés (userLabel, systemLabel, internalLabel, séparés par des espaces). La valeur par défaut est userLabel + systemLabel.
• --filter <text> — préfixe permettant de faire correspondre les noms de libellés (StartsWith côté serveur, il ne s'agit pas d'une recherche générale de sous-chaînes).
• --sort-by <expr> — expression de tri, par exemple name asc.
• --limit <n> — taille de la page. La valeur par défaut est 50.
• --offset <n> — résultats à ignorer. La valeur par défaut est 0.

Exemple

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

Format des données

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

Chaque ligne est simplement { "Name": "<label>" } - aucune Id, ObjectId ou LabelType n'est renvoyée par list. Pour obtenir le détail complet d’une ligne d’affectation spécifique (y compris son Id), utilisez objectlabel get.

Obtenir le libellé d'objet uip tm

Obtenez une ligne d'affectation de libellé unique par son UUID d'affectation.

Arguments

Aucun

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet auquel le libellé appartient.
• --label-id <uuid> (obligatoire) — UUID de la ligne d'attribution du libellé. Il s’agit de l’UUID de l’enregistrement de l’affectation, et non d’un nom de libellé.

Exemple

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

Format des données

{
  "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 dans cette réponse est PascalCase (UserLabel, SystemLabel, InternalLabel), même si les indicateurs d'entrée --label-type/--label-types prennent la forme de fil camelCase.

ajout de libellé d'objet uip tm

Ajoutez des libellés à un ou plusieurs objets. Deux comportements distincts selon que l'élément --label-type est défini ou non:

• Sans --label-type (par défaut): un seul appel d'ajout en bloc sur tous les objets et libellés. Transmettez --remove-other-labels pour en faire un ensemble d'autorité - après l'ajout, tous les libellés non système sur ces objets qui ne sont pas dans --labels sont supprimés.
• Avec --label-type: chaque libellé est attribué individuellement (en boucle chaque paire objet × libellé), afin qu’un type de libellé spécifique puisse être enregistré. --remove-other-labels est ignoré dans ce mode.

Arguments

Aucun

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet.
• --object-ids <uuid...> (obligatoire) : UUID d'objets séparés par des espaces auxquels appliquer les libellés.
• --labels <name...> (obligatoire) : noms de libellés séparés par des espaces à ajouter.
• --label-type <type> — type de libellé (userLabel, systemLabel, internalLabel). Lorsque ce champ est défini, bascule vers le chemin d’attribution par paire décrit ci-dessus.
• --remove-other-labels — après l'ajout, supprimez tous les libellés non système liés à ces objets non présents dans --labels. Ignoré lorsque --label-type est défini.

Exemples

# 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

Format des données

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

Lorsque --label-type est transmis, la réponse l'inclut:

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

Suppression du libellé d'objet uip tm

Supprimez les libellés d'un ou plusieurs objets. Il s'agit d'une opération irréversible , qui nécessite -y, --yes; la CLI ne s'affiche jamais. Saisissez --labels pour supprimer des libellés spécifiques, ou --remove-all-labels pour effacer chaque libellé non-système des objets spécifiés — les deux s'excluant mutuellement.

Arguments

Aucun

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet.
• --object-ids <uuid...> (requis) : UUID d'objets séparés par des espaces.
• --labels <name...> — noms de libellés séparés par des espaces à supprimer. Obligatoire si --remove-all-labels n'est pas défini.
• --remove-all-labels — efface chaque libellé non système sur les objets répertoriés. Capture mutuellement exclusive avec --labels.
• -y, --yes — confirmez cette opération irréversible. Requis — la CLI ne s'affiche jamais.

Exemples

# 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

Format des données

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

Avec --remove-all-labels, la réponse rapporte RemoveAllLabels au lieu de LabelCount, et Result est AllRemoved:

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

Associé

• exigences — les exigences peuvent comporter des libellés d'objet.
• champ personnalisé — un mécanisme de libellé distinct (customfield label) pour les valeurs de champ personnalisé de type Libellé; distinct des balises de forme libre de objectlabel.

Voir également

• Vue d’ensemble de Test Manager