Champ personnalisé UiPtm

Syntaxe et options de `uip tm false`, qui gère les définitions de champs personnalisés, les lignes de libellé et les lignes de valeur dans un projet Test Manager.

uip tm customfield gère les définitions de champs personnalisés sur un projet Test Manager. Les champs personnalisés étendent les exigences, les cas de test et les ensembles de test avec des métadonnées spécifiques au projet. Ce groupe de commandes a trois sous-groupes:

• customfield — gérez la définition de champ elle-même (liste, obtention, création, mise à jour, suppression)
• customfield label — gérez les lignes de champ de type Libellé (une carte JSON du nom de champ à une ou plusieurs valeurs de chaîne, par objet)
• customfield value — gérez les lignes de champ de type texte (une seule valeur de chaîne, par objet)

Important :

L'identifiant principal des définitions de champs est --field-id. Les lignes de libellé et de valeur sont identifiées par --label-id / --value-id, ou par la clé naturelle --object-type + --name + --object-id. L'indicateur --customfield-id n'existe pas.

Synthèse

# Field definitions
uip tm customfield list --project-key <key> [--object-types <types...>] [--data-types <types...>] [--name <name>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield get --project-key <key> (--field-id <uuid> | --name <name> --object-type <type>)
uip tm customfield create --project-key <key> --name <name> --data-type <Text|Label> (--object-type <type> | --scope-list <types...>) [--description <text>] [--default-value <value>] [--value-hints <hints>]
uip tm customfield update --project-key <key> (--field-id <uuid> | --name <name> --object-type <type>) [--rename-to <name>] [--description <text>] [--default-value <value>] [--value-hints <hints>] [--scope-list <types...>]
uip tm customfield delete --project-key <key> (--field-ids <uuid...> | --name <name> --object-type <type>) [-y]

# Labels
uip tm customfield label get --project-key <key> --object-type <type> --label-id <uuid>
uip tm customfield label list --project-key <key> --object-type <type> [--object-id <uuid>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield label create --project-key <key> --object-type <type> --object-id <uuid> --values <json>
uip tm customfield label add --project-key <key> --object-type <type> --custom-field-name <name> --object-ids <uuid...> --values <value...> [--replace-existing-values]
uip tm customfield label remove --project-key <key> --object-type <type> --custom-field-name <name> --object-ids <uuid...> (--values <value...> | --remove-all-values) [-y]

# Values
uip tm customfield value list --project-key <key> --object-type <type> [--object-id <uuid>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield value get --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>)
uip tm customfield value create --project-key <key> --object-type <type> --name <name> --object-id <uuid> --data-type <Text|Label> [--value <text>]
uip tm customfield value update --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [--data-type <Text|Label>] (--value <text> | --clear)
uip tm customfield value delete --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [-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é).

Remarque :

-t, --tenant est une option normale et visible.

--object-type (et --object-types/--scope-list où variable) accepte uniquement Requirement, TestCase ou TestSet. --data-type (et --data-types) accepte uniquement Text ou Label — il n'y a pas de type de données String, Integer ou Boolean.

---

Commandes de définition de champ

liste de champs personnalisés uip tm

Répertorier des définitions de champs personnalisés dans un projet. --project-key est requis; tous les autres filtres sont facultatifs.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-types <types...> — types d'objets séparés par des espaces par lesquels filtrer: Requirement, TestCase, TestSet.
• --data-types <types...> — types de données séparés par des espaces à filtrer par: Text, Label.
• --name <name> — correspondance de nom exact (filtre côté client; renvoie une ligne par type d'objet sur lequel le champ est défini).
• --filter <text> — recherche de sous-chaînes côté serveur dans les champs de définition.
• --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 customfield list \
  --project-key DEMO \
  --object-types TestCase

Format des données

{
  "Code": "CustomFieldDefinitionsList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "ProjectId": "p1",
      "Name": "Priority",
      "Description": "Test priority",
      "DefaultValue": "Medium",
      "ValueHints": "",
      "ObjectType": "TestCase",
      "DataType": "Text",
      "ScopeList": ["TestCase"]
    }
  ]
}

---

Obtenir le champ personnalisé uip tm

Obtenir une définition de champ personnalisé unique. Identifiez par --field-id, OU par --name + --object-type.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --field-id <uuid> — UUID de champ.
• --name <name> — nom de champ. Utilisé avec --object-type.
• --object-type <type> — le type d'objet auquel le champ appartient: Requirement, TestCase, TestSet. Utilisé avec --name.

Exemple

uip tm customfield get \
  --project-key DEMO \
  --field-id a1b2c3d4-0000-0000-0000-000000000001

Format des données

{
  "Code": "CustomFieldDefinitionGet",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "Name": "Priority",
    "Description": "Test priority",
    "DefaultValue": "Medium",
    "ValueHints": "",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "ScopeList": ["TestCase"]
  }
}

---

Création de champs personnalisés uip tm

Créez une nouvelle définition de champ personnalisé. Indiquez --object-type pour une seule étendue, OU --scope-list pour plusieurs étendues; les deux s'excluent mutuellement et une est requise.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --name <name> (obligatoire) : nom du champ.
• --data-type <type> (obligatoire) — Text ou Label.
• --object-type <type> — étendue unique: Requirement, TestCase, TestSet. Capture mutuellement exclusive avec --scope-list.
• --scope-list <types...> — étendue multi-objets (séparés par des espaces): Requirement, TestCase, TestSet. Capture mutuellement exclusive avec --object-type.
• --description <text> — description du champ.
• --default-value <text> — valeur par défaut amorcée dans chaque objet existant du type du champ.
• --value-hints <text> — Texte de l'indice d'IU affiché à côté du champ.

Exemple

uip tm customfield create \
  --project-key DEMO \
  --name Priority \
  --data-type Text \
  --object-type TestCase \
  --description "Test priority" \
  --default-value Medium

Format des données

{
  "Code": "CustomFieldDefinitionCreate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "Name": "Priority",
    "Description": "Test priority",
    "DefaultValue": "Medium",
    "ValueHints": "",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "ScopeList": ["TestCase"]
  }
}

---

mise à jour du champ personnalisé uip tm

Mettez à jour une définition de champ personnalisé existante. Identifiez par --field-id, OU par --name + --object-type. Les champs non spécifiés conserveront leurs valeurs actuelles.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --field-id <uuid> — UUID de champ.
• --name <name> — nom du champ (pour la recherche). Utilisé avec --object-type.
• --object-type <type> — le type d'objet auquel le champ appartient. Utilisé avec --name.
• --rename-to <name> — nouveau nom pour le champ.
• --description <text> — nouvelle description.
• --default-value <text> — nouvelle valeur par défaut.
• --value-hints <text> — nouveau texte de suggestion d'interface utilisateur.
• --scope-list <types...> — nouvelle étendue multi-objets (séparée par des espaces).

Exemple

uip tm customfield update \
  --project-key DEMO \
  --field-id a1b2c3d4-0000-0000-0000-000000000001 \
  --rename-to Severity

Format des données

{
  "Code": "CustomFieldDefinitionUpdate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Severity",
    "Result": "Updated"
  }
}

---

Suppression de champs personnalisés uip tm

Supprimez une ou plusieurs définitions de champs personnalisés. Identifiez par --field-ids (un ou plusieurs UUID), OU par --name + --object-type (simple, par clé naturelle). Suppression définitive sans cascade — les lignes de libellé/valeur orphelines ne sont pas nettoyées.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --field-ids <uuid...> — les UUID de champ séparés par un espace à supprimer.
• --name <name> — nom de champ (utilisé avec --object-type).
• --object-type <type> — le type d'objet auquel le champ appartient (utilisé avec --name).
• -y, --yes — confirmez cette opération irréversible. Requis — la CLI ne s'affiche jamais.

Exemple

uip tm customfield delete \
  --project-key DEMO \
  --field-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --yes

Format des données

{
  "Code": "CustomFieldDefinitionsDelete",
  "Data": { "Passed": 1, "Failed": 0 }
}

Passed/Failed sont des nombres, et non des détails par ID — la réponse ne reflète pas les UUID qui ont échoué. Les UUID inconnus transmis via --field-ids sont transférés vers le point de terminaison en bloc et comptabilisés comme Failed plutôt que d’être rejetés dès le départ.

---

Commandes de libellés

Les lignes de libellé comportent un objet JSON par instance d'objet, mappant le nom de champ personnalisé à un tableau de valeurs de chaîne ({"Priority":["High"],"Tags":["smoke","critical"]}).

Obtenir le libellé de champ personnalisé uip tm

Obtenez une ligne de libellé de champ personnalisé par --label-id. Pour rechercher par objet à la place, utilisez customfield label list --object-id <uuid> (renvoie la même ligne qu'un tableau à un élément).

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet auquel le libellé appartient: Requirement, TestCase, TestSet.
• --label-id <uuid> (obligatoire) — UUID de la ligne de libellé (pas le nom du libellé).

Exemple

uip tm customfield label get \
  --project-key DEMO \
  --object-type TestCase \
  --label-id f1b2c3d4-0000-0000-0000-000000000001

Format des données

{
  "Code": "CustomFieldLabelGet",
  "Data": {
    "Id": "f1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Values": { "Priority": ["High"], "Tags": ["smoke", "critical"] },
    "Created": "2025-01-01T00:00:00Z",
    "CreatedBy": "[e-mail]",
    "Updated": "2025-01-02T00:00:00Z",
    "UpdatedBy": "[e-mail]"
  }
}

---

liste des libellés de champ personnalisé uip tm

Répertoriez les lignes de libellé d'un type d'objet, affectées éventuellement à un objet spécifique.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet pour lequel lister les libellés.
• --object-id <uuid> — filtrer sur un UUID d'objet spécifique.
• --filter <text> — rechercher les lignes de libellé par valeur.
• --sort-by <expr> — expression de tri.
• --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 customfield label list \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

Format des données

{
  "Code": "CustomFieldLabelsList",
  "Data": [
    {
      "Id": "f1b2c3d4-0000-0000-0000-000000000001",
      "ProjectId": "p1",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjectType": "TestCase",
      "Values": { "Priority": ["High"], "Tags": ["smoke", "critical"] },
      "Created": "2025-01-01T00:00:00Z",
      "CreatedBy": "[e-mail]",
      "Updated": "2025-01-02T00:00:00Z",
      "UpdatedBy": "[e-mail]"
    }
  ]
}

---

Création de libellés de champ personnalisé uip tm

Mettez à jour et insérez les valeurs de libellé d'un objet. Le backend fusionne toutes les nouvelles clés de nom de champ dans une ligne existante pour le même objet - cela ne remplace pas la ligne entière.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d’objet auquel attacher les libellés.
• --object-id <uuid> (requis) — UUID de l'objet à labelliser.
• --values <json> (requis) : un champ de mappage d'objet JSON non vide vers des tableaux de chaînes, par exemple {"Priority":["High"],"Tags":["smoke","critical"]}. Un tableau JSON ou une valeur qui n'est pas un tableau de chaînes par clé est rejetée côté client.

Exemple

uip tm customfield label create \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --values '{"Priority":["High"],"Tags":["smoke"]}'

Format des données

{
  "Code": "CustomFieldLabelCreate",
  "Data": {
    "Id": "f1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Values": { "Priority": ["High"], "Tags": ["smoke"] },
    "Created": "2025-01-01T00:00:00Z",
    "CreatedBy": "[e-mail]",
    "Updated": "2025-01-01T00:00:00Z",
    "UpdatedBy": "[e-mail]"
  }
}

---

ajout de libellé de champ personnalisé uip tm

Ajoutez des valeurs de libellé à un champ personnalisé nommé sur plusieurs objets en un seul appel.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet.
• --custom-field-name <name> (obligatoire) — nom d'une définition de champ personnalisé existante pour ce type d'objet.
• --object-ids <uuid...> (obligatoire) : UUID d'objets séparés par des espaces auxquels appliquer le libellé.
• --values <value...> (obligatoire) : valeurs de libellé séparées par des espaces à ajouter.
• --replace-existing-values — Remplacez les valeurs existantes au lieu de la fusion (par défaut: fusionner).

Exemple

uip tm customfield label add \
  --project-key DEMO \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids id1 id2 \
  --values High Critical

Format des données

{
  "Code": "CustomFieldLabelAdd",
  "Data": {
    "CustomFieldName": "Priority",
    "ObjectCount": 2,
    "Result": "Added"
  }
}

---

Suppression du libellé de champ personnalisé uip tm

Supprimez les valeurs de libellé d'un champ personnalisé nommé sur plusieurs objets. Il s'agit d'une opération irréversible , qui nécessite -y, --yes; la CLI ne s'affiche jamais.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet.
• --custom-field-name <name> (obligatoire) — nom du champ personnalisé.
• --object-ids <uuid...> (requis) : UUID d'objets séparés par des espaces.
• --values <value...> — les valeurs de libellé séparées par des espaces à supprimer. Obligatoire si --remove-all-values n'est pas défini.
• --remove-all-values — effacez toutes les valeurs de ce champ sur les objets répertoriés. Capture mutuellement exclusive avec --values.
• -y, --yes — confirmez cette opération irréversible. Requis — la CLI ne s'affiche jamais.

Exemple

uip tm customfield label remove \
  --project-key DEMO \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids id1 id2 \
  --values Critical \
  --yes

Format des données

{
  "Code": "CustomFieldLabelRemove",
  "Data": {
    "CustomFieldName": "Priority",
    "ObjectCount": 2,
    "Result": "Removed"
  }
}

---

Commandes de valeur

Les lignes de valeur comportent une seule valeur de type Texte par objet.

liste de valeurs de champ personnalisé uip tm

Répertorier les valeurs de champ personnalisé d'un type d'objet. Les résultats sont vides, sauf si --object-id est fourni.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet.
• --object-id <uuid> — UUID d'objet dont les valeurs doivent répertorier. Obligatoire dans la pratique - les résultats sont vides lorsqu'ils sont omis.
• --filter <text> — rechercher des valeurs par contenu.
• --sort-by <expr> — expression de tri.
• --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 customfield value list \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

Format des données

{
  "Code": "CustomFieldValuesList",
  "Data": [
    {
      "Id": "v1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "Value": "High",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjectType": "TestCase",
      "DataType": "Text",
      "Updated": "2025-01-02T00:00:00Z"
    }
  ]
}

---

Obtenir la valeur du champ personnalisé uip tm

Obtenez une seule ligne de valeur de champ personnalisé. Identifiez par --value-id, OU par --name + --object-id.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet.
• --value-id <uuid> — UUID de la ligne de valeur.
• --name <name> — nom de champ. Utilisé avec --object-id.
• --object-id <uuid> — UUID de l'objet. Utilisé avec --name.

Exemple

uip tm customfield value get \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001

Format des données

{
  "Code": "CustomFieldValueGet",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "Updated": "2025-01-02T00:00:00Z"
  }
}

---

Création de valeurs de champ personnalisé uip tm

Créez une ligne de valeur de champ personnalisé sur un objet.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet.
• --name <name> (obligatoire) — nom de champ personnalisé (doit correspondre à une définition existante).
• --object-id <uuid> (obligatoire) — UUID de l'objet auquel cette valeur est associée.
• --data-type <type> (obligatoire) — Text ou Label (doit correspondre à la définition).
• --value <text> — contenu de la valeur. Facultatif — omis pour créer une ligne vide.

Exemple

uip tm customfield value create \
  --project-key DEMO \
  --object-type TestCase \
  --name Priority \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --data-type Text \
  --value High

Format des données

{
  "Code": "CustomFieldValueCreate",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "Updated": "2025-01-02T00:00:00Z"
  }
}

---

mise à jour de la valeur du champ personnalisé uip tm

Mettez à jour une ligne de valeur de champ personnalisé existante. Identifiez par --value-id, OU par --name + --object-id. --value est requis, sauf si --clear est défini.

Remarque :

Un --value vide peut entraîner la suppression de la ligne au lieu de sa mise à jour lorsque son nom de champ ne correspond plus à une définition. Transmettez --clear pour reconnaître cette intention.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet.
• --value-id <uuid> — UUID de la ligne de valeur.
• --name <name> — nom de champ. Utilisé avec --object-id.
• --object-id <uuid> — UUID de l'objet. Utilisé avec --name.
• --data-type <type> — Text ou Label. Par défaut, le type de données actuel de la ligne.
• --value <text> — la nouvelle valeur. Obligatoire si --clear n'est pas défini.
• --clear — reconnais qu'un --value vide peut supprimer la ligne.

Exemple

uip tm customfield value update \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --value Critical

Format des données

{
  "Code": "CustomFieldValueUpdate",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Updated"
  }
}

---

suppression de la valeur du champ personnalisé uip tm

Supprimez une ligne de valeur de champ personnalisé. Identifiez par --value-id, OU par --name + --object-id.

Options

• --project-key <key> (obligatoire) : propriétaire du projet.
• --object-type <type> (obligatoire) : type d'objet.
• --value-id <uuid> — UUID de la ligne de valeur.
• --name <name> — nom de champ. Utilisé avec --object-id.
• --object-id <uuid> — UUID de l'objet. Utilisé avec --name.
• -y, --yes — confirmez cette opération irréversible. Requis — la CLI ne s'affiche jamais.

Exemple

uip tm customfield value delete \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --yes

Format des données

{
  "Code": "CustomFieldValueDelete",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}

---

Associé

• exigences — les exigences peuvent comporter des valeurs de champ personnalisés.
• testcases — les cas de test peuvent comporter des valeurs de champ personnalisées.

Voir également

• Vue d’ensemble de Test Manager