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 :

Every verb in this group needs a project (--project-id or --project-key) and --object-type, including get. list, add, and remove take the plural, space-separated --object-ids; get takes a single --object-id. --labels is plural; there is no --label flag.

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

All verbs honor the global options and the standard exit codes. Every verb accepts --log-level <level> (default Information). Every verb also accepts -t, --tenant <name> to run against a tenant other than the one your uip login session selected. It defaults to the session's tenant.

When you pass both --project-id and --project-key, --project-id wins. If you pass neither, the command fails with 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

List distinct label names in use for one object type (paginated). This does not return label assignment rows — use get for the labels on one object.

Arguments

Aucun

Options

• --project-id <id> — Test Manager project ID. Wins if --project-key is also given.
• --project-key <key> — Test Manager project key (for example, DEMO). Ignored if --project-id is also given.
• --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...> — label types to include (userLabel, systemLabel, internalLabel, generatedLabel, space-separated). The server always returns systemLabel, userLabel, and generatedLabel names and adds the types passed here, so this flag widens the result rather than narrowing it.
• --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" }
  ]
}

Each row is only { "Name": "<label>" } — list returns no Id, ObjectId, or LabelType. To see the labels on one object with their ids and label types, use objectlabel get.

Obtenir le libellé d'objet uip tm

Get the visible labels on one object — user, system, and generated labels — including label ids and label types. Internal labels are not returned. list returns distinct label names for an object type; get returns the full assignment rows for a single object.

Arguments

Aucun

Options

• --project-id <id> — Test Manager project ID. Wins if --project-key is also given.
• --project-key <key> — Test Manager project key (for example, DEMO). Ignored if --project-id is also given.
• --object-type <type> (obligatoire) : type d'objet auquel le libellé appartient.
• --object-id <uuid> (required) — object UUID, for example the Id from uip tm testcases list (or the list verb matching --object-type).

Exemple

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"
    }
  ]
}

Data is an array with one row per label on the object, and an empty array when the object has no visible labels. LabelType is PascalCase (UserLabel, SystemLabel, GeneratedLabel) even though the --label-type/--label-types input flags take the camelCase wire form.

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.
• With --label-type userLabel: each label is assigned individually (one call per object × label pair). --remove-other-labels is ignored in this mode.

Arguments

Aucun

Options

• --project-id <id> — Test Manager project ID. Wins if --project-key is also given.
• --project-key <key> — Test Manager project key (for example, DEMO). Ignored if --project-id is also given.
• --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> — label type. Only userLabel is accepted: objectlabel remove cannot detach a system label, so the CLI writes user labels only. When set, switches to the per-pair assign path described above.
• --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

Format des données

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

LabelCount counts distinct label names, case-insensitively. When --label-type is passed, the response includes it:

{
  "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.

• System labels are never removed. Matching system label names are reported in SkippedSystemLabels.
• Internal label names, and names of label types the CLI doesn't recognize, are never sent. With --labels, requested internal names are reported in SkippedInternalLabels; with --remove-all-labels, user or generated labels that share a name with an internal label are kept and reported there.
• remove reads the objects' labels before writing — at least two read requests per object, five objects at a time — so it needs read access to the listed objects. If the labels can't be read, or an object carries 500 or more label names, nothing is removed.
• If a removal request fails partway through, the error message lists the labels already removed.

Arguments

Aucun

Options

• --project-id <id> — Test Manager project ID. Wins if --project-key is also given.
• --project-key <key> — Test Manager project key (for example, DEMO). Ignored if --project-id is also given.
• --object-type <type> (obligatoire) : type d'objet.
• --object-ids <uuid...> (required) — space-separated object UUIDs. At most 100 distinct ids per call; duplicates are ignored.
• --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 — remove the user and generated labels on the listed objects, except any that share a name with an internal label. System and internal labels are kept, unlike clear-all in the Test Manager UI. Mutually exclusive with --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

Format des données

{
  "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"
  }
}

Champ	Description
ObjectCount	Number of distinct object ids processed.
LabelCount	With --labels, the number of distinct requested names (case-insensitive). Replaced by RemoveAllLabels: true with --remove-all-labels.
RemovedLabels	Label names removed, sorted.
SkippedSystemLabels	System label names that matched and were kept. Omitted when empty.
SkippedInternalLabels	Names kept because they are, or share a name with, an internal label. Omitted when empty.
Result	Removed, AllRemoved (with --remove-all-labels), or Skipped when nothing was removed.

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