UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

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 :

Chaque verbe de ce groupe nécessite un projet (--project-id ou --project-key) et --object-type, y compris get. list, add et remove prennent le --object-ids, séparé par des espaces; get prend un seul --object-id. --labels est au multiple; il n'y a pas d'indicateur --label .

Synthèse​

uip tm objectlabel list (--project-id <id> | --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-id <id> | --project-key <key>) --object-type <type> --object-id <uuid>
uip tm objectlabel add (--project-id <id> | --project-key <key>) --object-type <type> --object-ids <uuid...> --labels <name...> [--label-type <type>] [--remove-other-labels]
uip tm objectlabel remove (--project-id <id> | --project-key <key>) --object-type <type> --object-ids <uuid...> (--labels <name...> | --remove-all-labels) --yes
uip tm objectlabel list (--project-id <id> | --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-id <id> | --project-key <key>) --object-type <type> --object-id <uuid>
uip tm objectlabel add (--project-id <id> | --project-key <key>) --object-type <type> --object-ids <uuid...> --labels <name...> [--label-type <type>] [--remove-other-labels]
uip tm objectlabel remove (--project-id <id> | --project-key <key>) --object-type <type> --object-ids <uuid...> (--labels <name...> | --remove-all-labels) --yes

Tous les verbes respectent les options globales et les codes de sortie standard. Chaque verbe accepte --log-level <level> (par défaut Information). Chaque verbe accepte également -t, --tenant <name> pour s’exécuter contre un locataire autre que celui sélectionné par votre session uip login . Il s'agit par défaut du locataire de la session.

Lorsque vous transmettez à la fois --project-id et --project-key, --project-id l'emporte. Si vous ne transmettez ni l’un ni l’autre, la commande échoue avec ErrorCode: invalid_argument.

--object-type accepts Requirement, TestCase, TestSet, TestExecution, or TestCaseLog. --label-types on list accepts the wire-form values userLabel, systemLabel, internalLabel, and generatedLabel; --label-type on add accepts only userLabel. Both take the wire form, not the PascalCase forms used elsewhere in this 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 les libellés d’un même objet.

Arguments​

Aucun

Options​

  • --project-id <id> — ID du projet Test Manager. Gagne si --project-key est également donné.
  • --project-key <key> — Clé de projet Test Manager (par exemple, DEMO). Ignoré si --project-id est également fourni.
  • --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...> — types de libellé à inclure (userLabel, systemLabel, internalLabel, generatedLabel, séparés par des espaces). Le serveur renvoie toujours les noms systemLabel, userLabel et generatedLabel et ajoute les types transmis ici, de sorte que cet indicateur élargit le résultat plutôt que de le restreindre.
  • --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
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" }
  ]
}
{
  "Code": "ObjectLabelsList",
  "Data": [
    { "Name": "smoke" },
    { "Name": "smoke-test" }
  ]
}

Chaque ligne est uniquement { "Name": "<label>" } — list ne renvoie pas Id, ObjectId ou LabelType. Pour voir les libellés sur un objet avec leurs ID et leurs types de libellé, utilisez objectlabel get.

Obtenir le libellé d'objet uip tm​

Obtenez des libellés visibles sur un seul objet (utilisateur, système et libellés générés), y compris les identifiants de libellé et les types de libellé. Les libellés internes ne sont pas renvoyés. list renvoie des noms de libellé distincts pour un type d'objet; get renvoie les lignes d'affectation complètes pour un seul objet.

Arguments​

Aucun

Options​

  • --project-id <id> — ID du projet Test Manager. Gagne si --project-key est également donné.
  • --project-key <key> — Clé de projet Test Manager (par exemple, DEMO). Ignoré si --project-id est également fourni.
  • --object-type <type> (obligatoire) : type d'objet auquel le libellé appartient.
  • --object-id <uuid> (requis) : UUID de l'objet, par exemple le Id de uip tm testcases list (ou le verbe de liste correspondant --object-type).

Exemple​

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

Format des données​

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

Data est un tableau avec une ligne par libellé sur l'objet et un tableau vide lorsque l'objet n'a pas de libellé visible. LabelType est PascalCase (UserLabel, SystemLabel, GeneratedLabel), 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:

  • Without --label-type (default): a single bulk-add call across all objects and labels. Pass --remove-other-labels to make this an authoritative set — after adding, any non-system labels on these objects that are not in --labels are deleted.
  • Avec --label-type userLabel: chaque libellé est attribué individuellement (un appel par paire objet × libellé). --remove-other-labels est ignoré dans ce mode.

Arguments​

Aucun

Options​

  • --project-id <id> — ID du projet Test Manager. Gagne si --project-key est également donné.
  • --project-key <key> — Clé de projet Test Manager (par exemple, DEMO). Ignoré si --project-id est également fourni.
  • --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é. Seul userLabel est accepté: objectlabel remove ne peut pas détacher un libellé système, la CLI écrit uniquement les libellés utilisateur. 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 a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002 \
  --labels smoke regression

# With an explicit label type — assigns each label individually
uip tm objectlabel add \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002 \
  --labels smoke \
  --label-type userLabel
# Bulk add — multiple labels to multiple objects in one call
uip tm objectlabel add \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002 \
  --labels smoke regression

# With an explicit label type — assigns each label individually
uip tm objectlabel add \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002 \
  --labels smoke \
  --label-type userLabel

Format des données​

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

LabelCount compte les noms de libellé distincts, insensible à la casse. Lorsque --label-type est transmis, la réponse inclut:

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

Suppression du libellé d'objet uip tm​

Remove user and generated labels from up to 100 objects. Pass --labels to remove specific labels, or --remove-all-labels to remove every user and generated label on the listed objects; the two are mutually exclusive, and one is required. Names match case-insensitively. The removal is irreversible and requires -y, --yes.

  • Les étiquettes système ne sont jamais supprimées. Les noms de libellé système correspondants sont indiqués dans SkippedSystemLabels.
  • Les noms de libellé internes et les noms de types de libellés que la CLI ne reconnaît pas ne sont jamais envoyés. Avec --labels, les noms internes demandés sont signalés dans SkippedInternalLabels; avec --remove-all-labels, les libellés utilisateur ou générés qui partagent un nom avec un libellé interne sont conservés et y sont signalés.
  • remove lit les libellés des objets avant d’écrire (au moins deux requêtes de lecture par objet, cinq objets à la fois), il a donc besoin d’un accès en lecture aux objets répertoriés. Si les libellés ne peuvent pas être lus ou si un objet porte 500 noms de libellé ou plus, rien n’est supprimé.
  • Si une demande de suppression échoue à mi-parcours, le message d'erreur répertorie les libellés déjà supprimés.

Arguments​

Aucun

Options​

  • --project-id <id> — ID du projet Test Manager. Gagne si --project-key est également donné.
  • --project-key <key> — Clé de projet Test Manager (par exemple, DEMO). Ignoré si --project-id est également fourni.
  • --object-type <type> (obligatoire) : type d'objet.
  • --object-ids <uuid...> (requis) : UUID d'objets séparés par des espaces. Au moins 100 identifiants distincts par appel; les doublons sont ignorés.
  • --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 — supprimer les libellés utilisateur et générés sur les objets répertoriés, à l'exception de tous ceux qui partagent un nom avec un libellé interne. Les libellés système et internes sont conservés, contrairement à l'effacement de tous dans l'interface utilisateur de Test Manager. Capture mutuellement exclusive avec --labels
  • -y, --yes (required) — confirms the irreversible operation. The CLI never prompts; without --yes the command returns Result: "Failure" and exits 1.

Exemples​

# remove specific labels
uip tm objectlabel remove \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002 \
  --labels regression \
  --yes

# remove every user and generated label
uip tm objectlabel remove \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002 \
  --remove-all-labels \
  --yes
# remove specific labels
uip tm objectlabel remove \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002 \
  --labels regression \
  --yes

# remove every user and generated label
uip tm objectlabel remove \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002 \
  --remove-all-labels \
  --yes

Format des données​

{
  "Code": "ObjectLabelsRemove",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 1,
    "RemovedLabels": ["regression"],
    "Result": "Removed"
  }
}
{
  "Code": "ObjectLabelsRemove",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 1,
    "RemovedLabels": ["regression"],
    "Result": "Removed"
  }
}

Avec --remove-all-labels:

{
  "Code": "ObjectLabelsRemove",
  "Data": {
    "ObjectCount": 2,
    "RemoveAllLabels": true,
    "RemovedLabels": ["regression", "smoke"],
    "SkippedSystemLabels": ["automated"],
    "Result": "AllRemoved"
  }
}
{
  "Code": "ObjectLabelsRemove",
  "Data": {
    "ObjectCount": 2,
    "RemoveAllLabels": true,
    "RemovedLabels": ["regression", "smoke"],
    "SkippedSystemLabels": ["automated"],
    "Result": "AllRemoved"
  }
}
ChampDescription
ObjectCountNombre d'ID d'objets distincts traités.
LabelCountAvec --labels, le nombre de noms demandés distincts (insensibles à la casse). Remplacé par RemoveAllLabels: true par --remove-all-labels.
RemovedLabelsLes noms de libellé supprimés, triés.
SkippedSystemLabelsLes noms de libellés système qui correspondaient et ont été conservés. Omis lorsqu'il est vide.
SkippedInternalLabelsLes noms sont conservés, car ils sont, ou partagent un nom avec, un libellé interne. Omis lorsqu'il est vide.
ResultRemoved, AllRemoved (avec --remove-all-labels) ou Skipped lorsque rien n'a été supprimé.
  • 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​

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance(opens in new window)

Vous souhaitez apprendre ? UiPath Academy(opens in new window)

Vous avez des questions ? UiPath Forum(opens in new window)

Rester à jour