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. Vous pouvez créer des exigences manuellement ou les synchroniser à partir d’un connecteur de gestion du cycle de vie des applications (Application Lifecycle Management, ALM) externe (par exemple, Jira) si configuré dans Test Manager.

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>] [--container-id <uuid>] [--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> [--requirement-ids <uuid...>] [--updated-by <userId>] [--test-case-id <uuid>] [--labels <label...>] [--filter <text>] [--sort-by <expr>]
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 --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. La CLI sélectionne le point de terminaison principal le plus spécifique en fonction des indicateurs de filtre fournis — un filtre basé sur libellé uniquement utilise un chemin rapide; la combinaison de libellés avec d'autres filtres utilise le point de terminaison du filtre enrichi.

Arguments

Aucun

Options

Drapeau	Description
--project-key <key>	Requis. Projet à répertorier.
--filter <text>	Recherchez les exigences par nom ou par clé.
--requirement-ids <uuid...>	UUID séparés par des espaces à inclure. Route sur le point de terminaison du filtre enrichi.
--labels <labels...>	Noms de libellés séparés par des espaces par lesquels filtrer. Lorsqu'il est fourni seul, utilise un chemin rapide basé sur libellé uniquement.
--updated-by <userId>	Filtrez par l'ID utilisateur qui a mis à jour l'exigence pour la dernière fois.
--test-case-id <uuid>	Renvoyez uniquement les exigences liées à ce 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 du 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

Format des données

{
  "Code": "RequirementsList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjKey": "DEMO:1",
      "ProjectId": "00000000-0000-0000-0000-000000000abc",
      "Name": "User must be able to log in",
      "Description": "Login with valid credentials succeeds",
      "ContainerId": "c1c2c3c4-0000-0000-0000-000000000001",
      "ConnectorRequirementId": "ext-req-42",
      "ForeignReference": "JIRA-100",
      "CustomFieldLabels": { "Tags": ["smoke", "auth"] },
      "CustomFieldValues": { "Owner": "qa-team" },
      "Created": "2025-04-15T10:30:00Z",
      "CreatedBy": "11111111-2222-3333-4444-555555555555",
      "Updated": "2025-04-15T10:30:00Z",
      "UpdatedBy": "11111111-2222-3333-4444-555555555555"
    }
  ]
}

Champs clés: ObjKey — utilisés dans --requirement-key le get. Id — utilisé dans --requirement-id sur get, update, delete, list-testcase-ids et testcases. ForeignReference — défini via --external-reference sur create.

Obtenir les exigences uip tm

Obtenez une exigence unique par son UUID interne ou sa clé PROJECT:N. Transmettez --requirement-id ou --requirement-key — ils s'excluent mutuellement.

Arguments

Aucun

Options

Drapeau	Description
--project-key <key>	Requis. Propriétaire du projet.
--requirement-id <uuid>	UUID de l’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

Format des données

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

Création d'exigences uip tm

Créez une nouvelle exigence dans un projet.

Arguments

Aucun

Options

Drapeau	Description
--project-key <key>	Requis. Propriétaire du projet.
--name <name>	Requis. Nom de l’exigence.
--description <text>	Description sous forme libre. La valeur par défaut est vide.
--container-id <uuid>	UUID du conteneur dans lequel placer l'exigence (facultatif).
--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é. Doit être un UUID valide.

Exemple

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": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjKey": "DEMO:1",
    "Name": "User must be able to log in",
    "ForeignReference": "JIRA-100"
  }
}

mise à jour des exigences uip tm

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

Arguments

Aucun

Options

Drapeau	Description
--project-key <key>	Requis. Propriétaire du projet.
--requirement-id <uuid>	Requis. 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"

Format des données

{
  "Code": "RequirementUpdate",
  "Data": {
    "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. -y/--yes est requis — la CLI ne s'invite jamais de manière interactive. Un seul UUID et plusieurs UUID sont tous deux acheminés vers le même point de terminaison en bloc.

Arguments

Aucun

Options

Drapeau	Description
--project-key <key>	Requis. Propriétaire du projet.
--requirement-ids <uuid...>	Requis. UUID de l’exigence à supprimer (séparés par des espaces).
-y, --yes	Requis. Confirmez cette opération irréversible.

Exemples

# Delete a single requirement
uip tm requirements delete \
  --project-key DEMO \
  --requirement-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --yes

# Delete multiple requirements in one call
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": { "Passed": 2, "Failed": 0 }
}

exportation des exigences uip tm

Exportez les exigences vers un fichier .xlsx. Prend en charge les mêmes indicateurs de filtre que requirements list.

Arguments

Aucun

Options

Drapeau	Description
--project-key <key>	Requis. Propriétaire du projet.
--output-file <path>	Requis. Chemin d’accès pour écrire le fichier d’exportation.
--requirement-ids <uuid...>	Filtrez par UUID d’exigence.
--updated-by <userId>	Filtrez par l'ID utilisateur qui a mis à jour l'exigence pour la dernière fois.
--test-case-id <uuid>	Filtrer par UUID de cas de test lié.
--labels <label...>	Filtrer par étiquettes.
--filter <text>	Rechercher par nom ou par clé.
--sort-by <expr>	Trier les résultats.

Exemple

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

Format des données

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

uip tm requirements list-testcase-ids

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

Arguments

Aucun

Options

Drapeau	Description
--project-key <key>	Requis. Propriétaire du projet.
--requirement-id <uuid>	Requis. UUID interne de l’exigence.

Exemple

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

Format des données

{
  "Code": "RequirementTestCaseIdsList",
  "Data": { "TestCaseIds": ["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

Drapeau	Description
--project-key <key>	Requis. Propriétaire du projet.
--requirement-id <uuid>	Requis. Exigence à modifier.
--add-testcase-ids <uuid...>	UUID du cas de test séparé par des espaces à lier.
--remove-testcase-ids <uuid...>	UUID du cas de test séparé 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

Format de données — Joindre

{ "Code": "RequirementAssignTestCases", "Data": { "Id": "a1b2c3d4-...", "Assigned": 2, "Result": "Assigned" } }

Format des données — détacher

{ "Code": "RequirementUnassignTestCases", "Data": { "Id": "a1b2c3d4-...", "Unassigned": 1, "Result": "Unassigned" } }

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

Drapeau	Description
--project-key <key>	Requis. 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>	Filtrez par l'ID 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 du 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

Format des données

{
  "Code": "RequirementsListByTestExecution",
  "Data": [{ "Id": "a1b2c3d4-0000-0000-0000-000000000001", "ObjKey": "DEMO:1", "Name": "User must be able to log in" }]
}

Associé

• projet — propriétaire de l'étendue du projet.
• cas de test — cas de test qui peuvent être liés aux exigences.
• exécutions — source du --execution-id utilisé par list-by-test-execution.

Voir également

• Vue d’ensemble de Test Manager