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.

Exigences UiPtm

Syntaxe et options de `uip tm requirements`, qui gère les exigences dans un projet Test Manager: création, lecture, mise à jour, suppression, exportation et lien vers des cas de test.

uip tm requirements gère les exigences dans un projet Test Manager. Les exigences constituent la couche de traçabilité: elles expriment ce que le système doit faire, et chaque exigence peut être liée à un ou plusieurs cas de test pour afficher la couverture.

Synthèse

uip tm requirements list --project-key <key> [--filter <text>] [--requirement-ids <ids...>] [--labels <labels...>] [--updated-by <userId>] [--test-case-id <uuid>] [--changed-since <datetime>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm requirements get --project-key <key> [--requirement-id <uuid>] [--requirement-key <key>]
uip tm requirements create --project-key <key> --name <name> [--description <text>] [--external-reference <ref>] [--connector-requirement-uuid <uuid>]
uip tm requirements update --project-key <key> --requirement-id <uuid> [--name <name>] [--description <text>]
uip tm requirements delete --project-key <key> --requirement-ids <uuid...> [-y]
uip tm requirements export --project-key <key> --output-file <path>
uip tm requirements list-testcase-ids --project-key <key> --requirement-id <uuid>
uip tm requirements testcases --project-key <key> --requirement-id <uuid> (--add-testcase-ids <uuid...> | --remove-testcase-ids <uuid...>)
uip tm requirements list-by-test-execution --project-key <key> --execution-id <uuid> [--labels <label...>] [--updated-by <userId>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm requirements list --project-key <key> [--filter <text>] [--requirement-ids <ids...>] [--labels <labels...>] [--updated-by <userId>] [--test-case-id <uuid>] [--changed-since <datetime>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm requirements get --project-key <key> [--requirement-id <uuid>] [--requirement-key <key>]
uip tm requirements create --project-key <key> --name <name> [--description <text>] [--external-reference <ref>] [--connector-requirement-uuid <uuid>]
uip tm requirements update --project-key <key> --requirement-id <uuid> [--name <name>] [--description <text>]
uip tm requirements delete --project-key <key> --requirement-ids <uuid...> [-y]
uip tm requirements export --project-key <key> --output-file <path>
uip tm requirements list-testcase-ids --project-key <key> --requirement-id <uuid>
uip tm requirements testcases --project-key <key> --requirement-id <uuid> (--add-testcase-ids <uuid...> | --remove-testcase-ids <uuid...>)
uip tm requirements list-by-test-execution --project-key <key> --execution-id <uuid> [--labels <label...>] [--updated-by <userId>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]

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).

liste des exigences uip tm

Répertoriez les exigences dans un projet avec un filtrage enrichi côté serveur.

Arguments

Aucun

Options

  • --project-key <key> (obligatoire) : projet à répertorier.
  • --filter <text> — recherchez les exigences par nom ou par clé.
  • --requirement-ids <uuid...> — UUID séparés par des espaces à inclure.
  • --labels <labels...> — noms de libellés séparés par des espaces par lesquels filtrer.
  • --updated-by <userId> — filtrer par ID de l'utilisateur qui a mis à jour l'exigence pour la dernière fois.
  • --test-case-id <uuid> — renvoie uniquement les exigences liées à cette UUID de cas de test.
  • --changed-since <datetime> — exigences de retour modifiées après cet horodatage ISO-8601.
  • --sort-by <expr> — expression de tri (nom de champ, éventuellement suffixé par :asc ou :desc).
  • --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 requirements list \
  --project-key DEMO \
  --labels "high-priority" \
  --limit 20
uip tm requirements list \
  --project-key DEMO \
  --labels "high-priority" \
  --limit 20

Format des données

{
  "Code": "RequirementsList",
  "Data": [
    {
      "RequirementKey": "DEMO:1",
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "User must be able to log in",
      "Description": "Login with valid credentials succeeds"
    }
  ]
}
{
  "Code": "RequirementsList",
  "Data": [
    {
      "RequirementKey": "DEMO:1",
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "User must be able to log in",
      "Description": "Login with valid credentials succeeds"
    }
  ]
}

Obtenir les exigences uip tm

Obtenez une seule exigence. Il convient de fournir soit --requirement-id , soit --requirement-key ; elles sont facultatives et mutuellement exclusives.

Arguments

Aucun

Options

  • --project-key <key> (obligatoire) : propriétaire du projet.
  • --requirement-id <uuid> — UUID d'exigence interne. Capture mutuellement exclusive avec --requirement-key
  • --requirement-key <key> — clé d'exigence (par exemple, DEMO:1). Capture mutuellement exclusive avec --requirement-id

Exemple

uip tm requirements get \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001
uip tm requirements get \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001

Format des données

{
  "Code": "RequirementGet",
  "Data": {
    "RequirementKey": "DEMO:1",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "User must be able to log in",
    "Description": "Login with valid credentials succeeds"
  }
}
{
  "Code": "RequirementGet",
  "Data": {
    "RequirementKey": "DEMO:1",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "User must be able to log in",
    "Description": "Login with valid credentials succeeds"
  }
}

Création d'exigences uip tm

Créez une nouvelle exigence dans un projet.

Arguments

Aucun

Options

  • --project-key <key> (obligatoire) : propriétaire du projet.
  • --name <name> (obligatoire) : nom de l'exigence.
  • --description <text> — description forme libre. La valeur par défaut est vide.
  • --external-reference <ref> — référence système externe (par exemple, un ID de ticket Jira).
  • --connector-requirement-uuid <uuid> — UUID d'un système d'exigences externe connecté.

Exemple

uip tm requirements create \
  --project-key DEMO \
  --name "User must be able to log in" \
  --external-reference "JIRA-123"
uip tm requirements create \
  --project-key DEMO \
  --name "User must be able to log in" \
  --external-reference "JIRA-123"

Format des données

{
  "Code": "RequirementCreate",
  "Data": {
    "RequirementKey": "DEMO:1",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "User must be able to log in"
  }
}
{
  "Code": "RequirementCreate",
  "Data": {
    "RequirementKey": "DEMO:1",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "User must be able to log in"
  }
}

mise à jour des exigences uip tm

Mettez à jour une exigence existante. Au moins un de ces champs doit être fourni.

Arguments

Aucun

Options

  • --project-key <key> (obligatoire) : propriétaire du projet.
  • --requirement-id <uuid> (obligatoire) — UUID interne de l'exigence à mettre à jour.
  • --name <name> — nouveau nom.
  • --description <text> — nouvelle description.

Exemple

uip tm requirements update \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --name "User must be able to log in with MFA"
uip tm requirements update \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --name "User must be able to log in with MFA"

Format des données

{
  "Code": "RequirementUpdate",
  "Data": {
    "RequirementKey": "DEMO:1",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "User must be able to log in with MFA",
    "Result": "Updated"
  }
}
{
  "Code": "RequirementUpdate",
  "Data": {
    "RequirementKey": "DEMO:1",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "User must be able to log in with MFA",
    "Result": "Updated"
  }
}

suppression des exigences uip tm

Supprimez une ou plusieurs exigences par leurs UUID internes.

Arguments

Aucun

Options

  • --project-key <key> (obligatoire) : propriétaire du projet.
  • --requirement-ids <uuid...> (requis) : les UUID internes séparés par des espaces à supprimer.
  • -y, --yes — ignorer l'invite de confirmation.

Exemple

uip tm requirements delete \
  --project-key DEMO \
  --requirement-ids a1b2c3d4-0000-0000-0000-000000000001 b2c3d4e5-0000-0000-0000-000000000001 \
  --yes
uip tm requirements delete \
  --project-key DEMO \
  --requirement-ids a1b2c3d4-0000-0000-0000-000000000001 b2c3d4e5-0000-0000-0000-000000000001 \
  --yes

Format des données

{
  "Code": "RequirementDelete",
  "Data": {
    "Deleted": 2,
    "Result": "Deleted"
  }
}
{
  "Code": "RequirementDelete",
  "Data": {
    "Deleted": 2,
    "Result": "Deleted"
  }
}

exportation des exigences uip tm

Exportez les exigences vers un fichier.

Arguments

Aucun

Options

  • --project-key <key> (obligatoire) : propriétaire du projet.
  • --output-file <path> (obligatoire) : chemin d’accès pour écrire le fichier d’exportation.

Exemple

uip tm requirements export \
  --project-key DEMO \
  --output-file ./requirements-export.xlsx
uip tm requirements export \
  --project-key DEMO \
  --output-file ./requirements-export.xlsx

Format des données

{
  "Code": "RequirementExport",
  "Data": {
    "OutputPath": "./requirements-export.xlsx",
    "Result": "Exported"
  }
}
{
  "Code": "RequirementExport",
  "Data": {
    "OutputPath": "./requirements-export.xlsx",
    "Result": "Exported"
  }
}

uip tm requirements list-testcase-ids

Répertorie les UUID des cas de test liés à une exigence.

Arguments

Aucun

Options

  • --project-key <key> (obligatoire) : propriétaire du projet.
  • --requirement-id <uuid> (obligatoire) : UUID interne de l’exigence.

Exemple

uip tm requirements list-testcase-ids \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001
uip tm requirements list-testcase-ids \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001

Format des données

{
  "Code": "RequirementTestCaseIds",
  "Data": [
    "b2c3d4e5-0000-0000-0000-000000000001",
    "c3d4e5f6-0000-0000-0000-000000000001"
  ]
}
{
  "Code": "RequirementTestCaseIds",
  "Data": [
    "b2c3d4e5-0000-0000-0000-000000000001",
    "c3d4e5f6-0000-0000-0000-000000000001"
  ]
}

cas de test des exigences uip tm

Ajoutez ou supprimez des liens de cas de test sur une exigence. Transmettez --add-testcase-ids ou --remove-testcase-ids (pas les deux dans le même appel).

Arguments

Aucun

Options

  • --project-key <key> (obligatoire) : propriétaire du projet.
  • --requirement-id <uuid> (obligatoire) — exigence à modifier.
  • --add-testcase-ids <uuid...> — UUID de cas de test séparés par des espaces à lier.
  • --remove-testcase-ids <uuid...> — UUID de cas de test séparés par des espaces à dissocier.

Exemples

# link test cases
uip tm requirements testcases \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --add-testcase-ids b2c3d4e5-0000-0000-0000-000000000001 c3d4e5f6-0000-0000-0000-000000000001

# unlink test cases
uip tm requirements testcases \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --remove-testcase-ids b2c3d4e5-0000-0000-0000-000000000001
# link test cases
uip tm requirements testcases \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --add-testcase-ids b2c3d4e5-0000-0000-0000-000000000001 c3d4e5f6-0000-0000-0000-000000000001

# unlink test cases
uip tm requirements testcases \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --remove-testcase-ids b2c3d4e5-0000-0000-0000-000000000001

Format des données

{
  "Code": "RequirementTestCases",
  "Data": {
    "RequirementId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Updated"
  }
}
{
  "Code": "RequirementTestCases",
  "Data": {
    "RequirementId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Updated"
  }
}

Liste des exigences uip tm par exécution de test

Répertoriez les exigences couvertes par une exécution de test spécifique. Renvoie les exigences dont les cas de test liés ont été inclus dans cette exécution.

Arguments

Aucun

Options

  • --project-key <key> (obligatoire) : propriétaire du projet.
  • --execution-id <uuid> (requis) : UUID de l'exécution de test.
  • --labels <label...> — Filtrer par noms de libellés (séparés par des espaces).
  • --updated-by <userId> — filtrer par ID de l'utilisateur qui a mis à jour l'exigence pour la dernière fois.
  • --filter <text> — recherchez les exigences par nom ou par clé.
  • --sort-by <expr> — expression de tri (nom de champ, éventuellement suffixé par :asc ou :desc).
  • --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 requirements list-by-test-execution \
  --project-key DEMO \
  --execution-id b2c3d4e5-0000-0000-0000-000000000001
uip tm requirements list-by-test-execution \
  --project-key DEMO \
  --execution-id b2c3d4e5-0000-0000-0000-000000000001

Format des données

{
  "Code": "RequirementsListByTestExecution",
  "Data": [
    {
      "RequirementKey": "DEMO:1",
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "User must be able to log in",
      "Description": "Login with valid credentials succeeds"
    }
  ]
}
{
  "Code": "RequirementsListByTestExecution",
  "Data": [
    {
      "RequirementKey": "DEMO:1",
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "User must be able to log in",
      "Description": "Login with valid credentials succeeds"
    }
  ]
}
  • projet — propriétaire de l'étendue du projet.
  • cas de test — cas de test qui peuvent être liés aux exigences.

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