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.

Champ personnalisé UiPtm

uip tm customfield gère les définitions de champs personnalisés sur un locataire Test Manager. Les champs personnalisés étendent les entités de cas de test et d'exigence 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 attributions de libellés appliquées aux objets
  • customfield value — gérez les valeurs autorisées pour un champ
Important :

L'identifiant principal des définitions de champs est --field-id. Étendue des commandes de libellé et de valeur par --object-type combiné avec --object-id, --label-id ou --value-id. L'indicateur --customfield-id n'existe pas dans v1.196.

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 --object-type <type> (--field-id <uuid> | --name <name>)
uip tm customfield create --project-key <key> --name <name> --object-type <type> --data-type <type> [--scope-list <list>] [--description <text>] [--default-value <value>] [--value-hints <hints>]
uip tm customfield update --object-type <type> (--field-id <uuid> | --name <name>) [--rename-to <name>] [--description <text>] [--default-value <value>] [--value-hints <hints>] [--scope-list <list>]
uip tm customfield delete --object-type <type> (--field-ids <uuid...> | --name <name>) [-y]

# Labels
uip tm customfield label get --object-type <type> --label-id <uuid>
uip tm customfield label list --object-type <type> [--object-id <uuid>] [--limit <n>] [--offset <n>]
uip tm customfield label create --object-type <type> --object-id <uuid> --values <json>
uip tm customfield label add --object-type <type> --custom-field-name <name> --object-ids <uuid...> --values <values...>
uip tm customfield label remove --object-type <type> --custom-field-name <name> --object-ids <uuid...> (--values <values...> | --remove-all-values)

# Values
uip tm customfield value list --object-type <type> [--object-id <uuid>] [--limit <n>] [--offset <n>]
uip tm customfield value get --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>)
uip tm customfield value create --object-type <type> --name <name> --object-id <uuid> --data-type <type> --value <value>
uip tm customfield value update --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) --value <value> [--clear]
uip tm customfield value delete --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [-y]
# 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 --object-type <type> (--field-id <uuid> | --name <name>)
uip tm customfield create --project-key <key> --name <name> --object-type <type> --data-type <type> [--scope-list <list>] [--description <text>] [--default-value <value>] [--value-hints <hints>]
uip tm customfield update --object-type <type> (--field-id <uuid> | --name <name>) [--rename-to <name>] [--description <text>] [--default-value <value>] [--value-hints <hints>] [--scope-list <list>]
uip tm customfield delete --object-type <type> (--field-ids <uuid...> | --name <name>) [-y]

# Labels
uip tm customfield label get --object-type <type> --label-id <uuid>
uip tm customfield label list --object-type <type> [--object-id <uuid>] [--limit <n>] [--offset <n>]
uip tm customfield label create --object-type <type> --object-id <uuid> --values <json>
uip tm customfield label add --object-type <type> --custom-field-name <name> --object-ids <uuid...> --values <values...>
uip tm customfield label remove --object-type <type> --custom-field-name <name> --object-ids <uuid...> (--values <values...> | --remove-all-values)

# Values
uip tm customfield value list --object-type <type> [--object-id <uuid>] [--limit <n>] [--offset <n>]
uip tm customfield value get --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>)
uip tm customfield value create --object-type <type> --name <name> --object-id <uuid> --data-type <type> --value <value>
uip tm customfield value update --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) --value <value> [--clear]
uip tm customfield value delete --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 -t, --tenant <name> et --log-level <level> (par défaut Information).


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.

Options
  • --project-key <key> (obligatoire) : propriétaire du projet.
  • --object-types <types...> — les types d'objets séparés par des espaces par lesquels filtrer.
  • --data-types <types...> — les types de données séparés par des espaces par lesquels filtrer.
  • --name <name> — filtrer par nom de champ exact.
  • --filter <text> — recherche en texte libre.
  • --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 list \
  --project-key DEMO \
  --object-types TestCase
uip tm customfield list \
  --project-key DEMO \
  --object-types TestCase
Format des données
{
  "Code": "CustomFieldList",
  "Data": [
    {
      "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "ObjectType": "TestCase",
      "DataType": "String"
    }
  ]
}
{
  "Code": "CustomFieldList",
  "Data": [
    {
      "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "ObjectType": "TestCase",
      "DataType": "String"
    }
  ]
}

Obtenir le champ personnalisé uip tm

Obtenir une définition de champ personnalisé unique.

Options
  • --object-type <type> (obligatoire) : type d'objet auquel le champ appartient.
  • --field-id <uuid> — UUID de champ. Capture mutuellement exclusive avec --name
  • --name <name> — nom de champ. Capture mutuellement exclusive avec --field-id
Exemple
uip tm customfield get \
  --object-type TestCase \
  --field-id c1b2c3d4-0000-0000-0000-000000000001
uip tm customfield get \
  --object-type TestCase \
  --field-id c1b2c3d4-0000-0000-0000-000000000001
Format des données
{
  "Code": "CustomFieldGet",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "ObjectType": "TestCase",
    "DataType": "String"
  }
}
{
  "Code": "CustomFieldGet",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "ObjectType": "TestCase",
    "DataType": "String"
  }
}

Création de champs personnalisés uip tm

Créez une nouvelle définition de champ personnalisé.

Options
  • --project-key <key> (obligatoire) : propriétaire du projet.
  • --name <name> (obligatoire) : nom du champ.
  • --object-type <type> (obligatoire) : type d’objet auquel attacher le champ (par exemple, TestCase, TestSet).
  • --data-type <type> (obligatoire) : type de données du champ (par exemple, String, Integer, Boolean).
  • --scope-list <list> — restrictions d'étendue pour le champ.
  • --description <text> — description du champ.
  • --default-value <value> — valeur par défaut pour les nouveaux objets.
  • --value-hints <hints> — suggestions de valeur ou énumération autorisées pour le champ.
Exemple
uip tm customfield create \
  --project-key DEMO \
  --name "Priority" \
  --object-type TestCase \
  --data-type String \
  --value-hints "Low,Medium,High"
uip tm customfield create \
  --project-key DEMO \
  --name "Priority" \
  --object-type TestCase \
  --data-type String \
  --value-hints "Low,Medium,High"
Format des données
{
  "Code": "CustomFieldCreate",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "ObjectType": "TestCase",
    "DataType": "String"
  }
}
{
  "Code": "CustomFieldCreate",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "ObjectType": "TestCase",
    "DataType": "String"
  }
}

mise à jour du champ personnalisé uip tm

Mettez à jour une définition de champ personnalisé existante.

Options
  • --object-type <type> (obligatoire) : type d'objet auquel le champ appartient.
  • --field-id <uuid> — UUID de champ. Capture mutuellement exclusive avec --name
  • --name <name> — nom du champ (pour la recherche). Capture mutuellement exclusive avec --field-id
  • --rename-to <name> — nouveau nom pour le champ.
  • --description <text> — nouvelle description.
  • --default-value <value> — nouvelle valeur par défaut.
  • --value-hints <hints> — nouvelles suggestions de valeur autorisée.
  • --scope-list <list> — nouvelles restrictions d'étendue.
Exemple
uip tm customfield update \
  --object-type TestCase \
  --field-id c1b2c3d4-0000-0000-0000-000000000001 \
  --rename-to "Severity"
uip tm customfield update \
  --object-type TestCase \
  --field-id c1b2c3d4-0000-0000-0000-000000000001 \
  --rename-to "Severity"
Format des données
{
  "Code": "CustomFieldUpdate",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Severity",
    "Result": "Updated"
  }
}
{
  "Code": "CustomFieldUpdate",
  "Data": {
    "FieldId": "c1b2c3d4-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.

Options
  • --object-type <type> (obligatoire) : type d'objet auquel les champs appartiennent.
  • --field-ids <uuid...> — les UUID de champ séparés par un espace à supprimer. Capture mutuellement exclusive avec --name
  • --name <name> — nom du champ à supprimer. Capture mutuellement exclusive avec --field-ids
  • -y, --yes — ignorer l'invite de confirmation.
Exemple
uip tm customfield delete \
  --object-type TestCase \
  --field-ids c1b2c3d4-0000-0000-0000-000000000001 \
  --yes
uip tm customfield delete \
  --object-type TestCase \
  --field-ids c1b2c3d4-0000-0000-0000-000000000001 \
  --yes
Format des données
{
  "Code": "CustomFieldDelete",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}
{
  "Code": "CustomFieldDelete",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}

Commandes de libellés

Obtenir le libellé de champ personnalisé uip tm

Obtenez une affectation de libellé unique par son UUID.

Options
  • --object-type <type> (obligatoire) : type d'objet auquel le libellé appartient.
  • --label-id <uuid> (obligatoire) — UUID de l'attribution de libellé (pas le nom du libellé).
Exemple
uip tm customfield label get \
  --object-type TestCase \
  --label-id l1b2c3d4-0000-0000-0000-000000000001
uip tm customfield label get \
  --object-type TestCase \
  --label-id l1b2c3d4-0000-0000-0000-000000000001
Format des données
{
  "Code": "CustomFieldLabelGet",
  "Data": {
    "LabelId": "l1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Label": "Priority"
  }
}
{
  "Code": "CustomFieldLabelGet",
  "Data": {
    "LabelId": "l1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Label": "Priority"
  }
}

liste des libellés de champ personnalisé uip tm

Répertoriez les attributions de libellés pour un type d'objet, éventuellement limitées à un objet spécifique.

Options
  • --object-type <type> (obligatoire) : type d'objet pour lequel lister les libellés.
  • --object-id <uuid> — filtrer sur un UUID d'objet spécifique.
  • --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 \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001
uip tm customfield label list \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001
Format des données
{
  "Code": "CustomFieldLabelList",
  "Data": [
    {
      "LabelId": "l1b2c3d4-0000-0000-0000-000000000001",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "Label": "Priority"
    }
  ]
}
{
  "Code": "CustomFieldLabelList",
  "Data": [
    {
      "LabelId": "l1b2c3d4-0000-0000-0000-000000000001",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "Label": "Priority"
    }
  ]
}

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

Créez un nouveau libellé sur un objet.

Options
  • --object-type <type> (obligatoire) : type d’objet auquel attacher le libellé.
  • --object-id <uuid> (requis) — UUID de l'objet à labelliser.
  • --values <json> (obligatoire) — Tableau JSON des valeurs de libellé à appliquer.
Exemple
uip tm customfield label create \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --values '[{"name":"Priority","value":"High"}]'
uip tm customfield label create \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --values '[{"name":"Priority","value":"High"}]'
Format des données
{
  "Code": "CustomFieldLabelCreate",
  "Data": {
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Created"
  }
}
{
  "Code": "CustomFieldLabelCreate",
  "Data": {
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Created"
  }
}

ajout de libellé de champ personnalisé uip tm

Ajoutez des valeurs de libellé à un ou plusieurs objets pour un champ personnalisé nommé.

Options
  • --object-type <type> (obligatoire) : type d'objet.
  • --custom-field-name <name> (obligatoire) — nom du champ personnalisé.
  • --object-ids <uuid...> (obligatoire) : UUID d'objets séparés par des espaces auxquels appliquer le libellé.
  • --values <values...> (obligatoire) : valeurs de libellé séparées par des espaces à ajouter.
Exemple
uip tm customfield label add \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --values High
uip tm customfield label add \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --values High
Format des données
{
  "Code": "CustomFieldLabelAdd",
  "Data": {
    "Result": "Added"
  }
}
{
  "Code": "CustomFieldLabelAdd",
  "Data": {
    "Result": "Added"
  }
}

Suppression du libellé de champ personnalisé uip tm

Supprimez les valeurs de libellé d'un ou plusieurs objets pour un champ personnalisé nommé.

Options
  • --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 <values...> — les valeurs de libellé séparées par des espaces à supprimer.
  • --remove-all-values — supprime toutes les valeurs de libellé pour ce champ des objets spécifiés. Capture mutuellement exclusive avec --values
Exemple
uip tm customfield label remove \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --values High
uip tm customfield label remove \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --values High
Format des données
{
  "Code": "CustomFieldLabelRemove",
  "Data": {
    "Result": "Removed"
  }
}
{
  "Code": "CustomFieldLabelRemove",
  "Data": {
    "Result": "Removed"
  }
}

Commandes de valeur

liste de valeurs de champ personnalisé uip tm

Répertoriez les valeurs de champ personnalisé d'un type d'objet, associées éventuellement à un objet spécifique.

Options
  • --object-type <type> (obligatoire) : type d'objet.
  • --object-id <uuid> — filtrer sur un UUID d'objet spécifique.
  • --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 \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001
uip tm customfield value list \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001
Format des données
{
  "Code": "CustomFieldValueList",
  "Data": [
    {
      "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "Value": "High"
    }
  ]
}
{
  "Code": "CustomFieldValueList",
  "Data": [
    {
      "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "Value": "High"
    }
  ]
}

Obtenir la valeur du champ personnalisé uip tm

Obtenez une seule valeur de champ personnalisé.

Options
  • --object-type <type> (obligatoire) : type d'objet.
  • --value-id <uuid> — valeur UUID. mutuellement exclusif avec --name + --object-id
  • --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 \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001
uip tm customfield value get \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001
Format des données
{
  "Code": "CustomFieldValueGet",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High"
  }
}
{
  "Code": "CustomFieldValueGet",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High"
  }
}

Création de valeurs de champ personnalisé uip tm

Définir une valeur de champ personnalisé sur un objet.

Options
  • --object-type <type> (obligatoire) : type d'objet.
  • --name <name> (obligatoire) — nom de champ personnalisé.
  • --object-id <uuid> (obligatoire) — UUID de l'objet.
  • --data-type <type> (obligatoire) : type de données de la valeur (par exemple, String, Integer).
  • --value <value> (obligatoire) : la valeur à définir.
Exemple
uip tm customfield value create \
  --object-type TestCase \
  --name Priority \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --data-type String \
  --value High
uip tm customfield value create \
  --object-type TestCase \
  --name Priority \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --data-type String \
  --value High
Format des données
{
  "Code": "CustomFieldValueCreate",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High"
  }
}
{
  "Code": "CustomFieldValueCreate",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High"
  }
}

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

Mettez à jour une valeur de champ personnalisé existante.

Options
  • --object-type <type> (obligatoire) : type d'objet.
  • --value-id <uuid> — valeur UUID. mutuellement exclusif avec --name + --object-id
  • --name <name> — nom de champ. Utilisé avec --object-id.
  • --object-id <uuid> — UUID de l'objet. Utilisé avec --name.
  • --value <value> (obligatoire) : la nouvelle valeur.
  • --clear — effacez la valeur au lieu de la définir.
Exemple
uip tm customfield value update \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --value Critical
uip tm customfield value update \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --value Critical
Format des données
{
  "Code": "CustomFieldValueUpdate",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Value": "Critical",
    "Result": "Updated"
  }
}
{
  "Code": "CustomFieldValueUpdate",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Value": "Critical",
    "Result": "Updated"
  }
}

suppression de la valeur du champ personnalisé uip tm

Supprimez une valeur de champ personnalisé.

Options
  • --object-type <type> (obligatoire) : type d'objet.
  • --value-id <uuid> — valeur UUID. mutuellement exclusif avec --name + --object-id
  • --name <name> — nom de champ. Utilisé avec --object-id.
  • --object-id <uuid> — UUID de l'objet. Utilisé avec --name.
  • -y, --yes — ignorer l'invite de confirmation.
Exemple
uip tm customfield value delete \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --yes
uip tm customfield value delete \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --yes
Format des données
{
  "Code": "CustomFieldValueDelete",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}
{
  "Code": "CustomFieldValueDelete",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}

  • 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

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

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour