UIP TM の要件

Test Manager プロジェクト内の要件を管理する「uip tm requirements」の構文とオプション (作成、読み取り、更新、削除、エクスポート、テスト ケースへのリンク)

uip tm requirements は、Test Manager プロジェクト内の要件を管理します。要件はトレーサビリティ レイヤーであり、システムが何を実行する必要があるかを表します。また、各要件を 1 つ以上のテスト ケースにリンクしてカバレッジを示すことができます。要件は手動で作成することも、Test Manager で設定されている場合は、外部のアプリケーション ライフサイクル管理 (ALM) コネクタ (Jira など) から同期することもできます。

概要

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

すべての動詞は、 グローバル オプション と標準の 終了コードを尊重します。すべての動詞は --log-level <level> を受け入れます (既定は Information)。

UIP TM 要件リスト

豊富なサーバー側フィルター処理を使用してプロジェクトの要件のリストを取得します。CLI は、指定されたフィルター フラグに基づいて最も具体的なバックエンド エンドポイントを選択します。ラベルのみのフィルターではファスト パスが使用されます。ラベルを他のフィルターと組み合わせると、リッチ フィルター エンドポイントが使用されます。

引数

設定はありません。

オプション

フラグ	説明
--project-key <key>	必須。リストするプロジェクト。
--filter <text>	要件を名前またはキーで検索する
--requirement-ids <uuid...>	含めるスペース区切りのUUID。リッチ フィルター エンドポイントを経由してルーティングします。
--labels <labels...>	フィルター処理に使用するスペース区切りのラベル名です。単独で指定した場合は、ラベルのみの高速パスが使用されます。
--updated-by <userId>	要件を最後に更新したユーザー ID でフィルター処理します。
--test-case-id <uuid>	このテスト ケースの UUID にリンクされている要件のみを返します。
--changed-since <datetime>	戻り値の要件は、この ISO-8601 タイムスタンプより後に変更されました。
--sort-by <expr>	並べ替え式 (フィールド名、任意でサフィックス :asc または :descを付けます)。
--limit <n>	ページ サイズ。既定値は 50です。
--offset <n>	スキップする結果。既定値は 0です。

例

uip tm requirements list \
  --project-key DEMO \
  --labels "high-priority" \
  --limit 20

データシェイプ

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

主なフィールド: ObjKey — getの --requirement-key で使用します。Id — get、update、delete、list-testcase-ids、testcasesの --requirement-id で使用します。ForeignReference — createの --external-reference で設定します。

UIP TM の要件 GET

内部 UUID または PROJECT:N キーで 1 つの要件を取得します。--requirement-id または --requirement-key のいずれかを渡します。これらは相互に排他的です。

引数

設定はありません。

オプション

フラグ	説明
--project-key <key>	必須。所有するプロジェクト。
--requirement-id <uuid>	内部要件 UUID。--requirement-keyと相互に排他的です。
--requirement-key <key>	要件キー (例: DEMO:1)。--requirement-idと相互に排他的です。

例

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

データシェイプ

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

uip tm の要件 作成

プロジェクトに新しい要件を作成します。

引数

設定はありません。

オプション

フラグ	説明
--project-key <key>	必須。所有するプロジェクト。
--name <name>	必須。要件名。
--description <text>	自由形式の説明。既定では空です。
--container-id <uuid>	要件を配置するコンテナー UUID です (任意)。
--external-reference <ref>	外部システムの参照 (例: Jira チケット ID)。
--connector-requirement-uuid <uuid>	接続された外部要件システムからの UUID。有効な UUID である必要があります。

例

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

データシェイプ

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

UIP TM の要件の更新

既存の要件を更新します。これらのフィールドの少なくとも 1 つを指定する必要があります。

引数

設定はありません。

オプション

フラグ	説明
--project-key <key>	必須。所有するプロジェクト。
--requirement-id <uuid>	必須。更新する要件の内部 UUID です。
--name <name>	新しい名前。
--description <text>	新しい説明。

例

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

データシェイプ

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

uip tm の要件 delete

1 つ以上の要件を削除します。-y/--yes が必要です。CLI は対話的にプロンプトを表示しません。1 つの UUID と複数の UUID はどちらも同じ一括エンドポイントを経由してルーティングします。

引数

設定はありません。

オプション

フラグ	説明
--project-key <key>	必須。所有するプロジェクト。
--requirement-ids <uuid...>	必須。削除する要件 UUID です (スペース区切り)。
-y, --yes	必須。この元に戻せない操作を確認します。

例

# 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

データシェイプ

{
  "Code": "RequirementDelete",
  "Data": { "Passed": 2, "Failed": 0 }
}

UIP TM 要件のエクスポート

要件を .xlsx ファイルにエクスポートするrequirements listと同じフィルター フラグがサポートされています。

引数

設定はありません。

オプション

フラグ	説明
--project-key <key>	必須。所有するプロジェクト。
--output-file <path>	必須。エクスポート ファイルを書き込むパスです。
--requirement-ids <uuid...>	要件の UUID でフィルター処理します。
--updated-by <userId>	要件を最後に更新したユーザー ID でフィルター処理します。
--test-case-id <uuid>	リンクされたテスト ケースの UUID でフィルター処理します。
--labels <label...>	ラベルでフィルター処理する。
--filter <text>	名前またはキーで検索する。
--sort-by <expr>	結果を並べ替える

例

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

データシェイプ

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

uip tm requirements list-testcase-ids

要件にリンクされているテスト ケースの UUID を一覧表示します。

引数

設定はありません。

オプション

フラグ	説明
--project-key <key>	必須。所有するプロジェクト。
--requirement-id <uuid>	必須。要件の内部 UUID。

例

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

データシェイプ

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

UIP TM の要件のテスト ケース

要件に対するテスト ケースのリンクを追加または削除します。--add-testcase-ids または --remove-testcase-ids のいずれかを渡します (同じ呼び出しで両方を渡すことはできません)。

引数

設定はありません。

オプション

フラグ	説明
--project-key <key>	必須。所有するプロジェクト。
--requirement-id <uuid>	必須。変更の要件。
--add-testcase-ids <uuid...>	リンクするスペース区切りのテスト ケースの UUID です。
--remove-testcase-ids <uuid...>	リンクを解除するテスト ケースの UUID をスペースで区切って指定します。

例

# 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

データ図形 — アタッチ

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

データシェイプ - デタッチ

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

uip tm の要件 list-by-test-execution

特定のテスト実行でカバーされる要件を一覧表示します。その実行にリンクされたテスト ケースが含まれていた要件を返します。

引数

設定はありません。

オプション

フラグ	説明
--project-key <key>	必須。所有するプロジェクト。
--execution-id <uuid>	必須。テスト実行の UUID。
--labels <label...>	ラベル名 (スペース区切り) でフィルター処理します。
--updated-by <userId>	要件を最後に更新したユーザー ID でフィルター処理します。
--filter <text>	要件を名前またはキーで検索する
--sort-by <expr>	並べ替え式 (フィールド名、任意でサフィックス :asc または :descを付けます)。
--limit <n>	ページ サイズ。既定値は 50です。
--offset <n>	スキップする結果。既定値は 0です。

例

uip tm requirements list-by-test-execution \
  --project-key DEMO \
  --execution-id b2c3d4e5-0000-0000-0000-000000000001

データシェイプ

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

関連

• プロジェクト — プロジェクト スコープを所有します。
• テスト ケース — 要件にリンクできるテスト ケースです。
• 実行 — list-by-test-executionによって使用される--execution-idのソースです。

参照

• Test Manager の概要