テスト ケース リポジトリからデータを取得する機能は、テスト ケースの詳細を必要とする他のアプリケーションでデータを簡単に利用できるようにするのに便利です。たとえば IDE やデータ解析ツールで利用できるほか、CLI を使って任意の操作を行うこともできます。
テスト ケースの詳細を取得すると、テスト ケースの設計に基づいて成果物を生成したり、外部ツールを使用してカスタマイズされた洞察を得たりすることができます。たとえば、以下のようなことが可能です。
-
- 外部ツールでテスト ケースの設計を解析します。
- 既存のテスト ケースから自動化されたテストを生成します。
| 実際のサンプル | ユース ケース |
|---|---|
| Jetbrains IDE | 自動テストのスケルトンを自動生成する機能を備えたテスト管理プラグイン |
テスト ケースの取得
たとえばテスト自動化ツールなどを使用して TestRail の外でテスト ケースの設計を解析し、テスト ケースを管理するには、テスト ケースから情報を取得する必要があります。
リクエスト
GET index.php?/api/v2/get_cases/{project_id}
curl -X GET \ -u "user@example.com:password" \ "https://example.testrail.io/index.php?/api/v2/get_cases/3"
リクエスト ボディのサンプル
なし
レスポンス ボディのサンプル
{
"offset": 0,
"limit": 250,
"size": 3,
"_links": {
"next": null,
"prev": null
},
"cases": [
{
"id": 4075,
"title": "Successfully login (Steps)",
"section_id": 497,
"template_id": 2,
"type_id": 11,
"priority_id": 3,
"milestone_id": null,
"refs": null,
"created_by": 5,
"created_on": 1684927352,
"updated_by": 5,
"updated_on": 1684929173,
"estimate": "1m",
"estimate_forecast": null,
"suite_id": 53,
"display_order": 1,
"is_deleted": 0,
"case_assignedto_id": null,
"custom_automation_type": 0,
"custom_preconds": "Go to login page ",
"custom_steps": null,
"custom_testrail_bdd_scenario": null,
"custom_expected": null,
"custom_steps_separated": [
{
"content": "Input valid email and password",
"expected": "Fields should be highlighted in green",
"additional_info": "",
"refs": ""
},
{
"content": "Click submit",
"expected": "User should be logged in and redirected to the homepage",
"additional_info": "",
"refs": ""
}
],
"custom_mission": null,
"custom_goals": null,
"comments": []
},
{
"id": 4077,
"title": "Successfully register new user (Text)",
"section_id": 497,
"template_id": 1,
"type_id": 11,
"priority_id": 3,
"milestone_id": null,
"refs": null,
"created_by": 5,
"created_on": 1684929198,
"updated_by": 5,
"updated_on": 1684929282,
"estimate": "2m 30s",
"estimate_forecast": null,
"suite_id": 53,
"display_order": 2,
"is_deleted": 0,
"case_assignedto_id": null,
"custom_automation_type": 0,
"custom_preconds": "Go to the register page",
"custom_steps": "Input valid information in all fields\r\nClick register",
"custom_testrail_bdd_scenario": null,
"custom_expected": "User should be registered and prompted to confirm his email address ",
"custom_steps_separated": null,
"custom_mission": null,
"custom_goals": null,
"comments": []
}
]
}
クエリー パラメーターによるテスト ケースのフィルタリング
-
- プロジェクト 34 (プロジェクト ID が 34) の ID が 2 のスイートにある、優先度が 3 または 4 のすべてのテスト ケースを取得する場合
GET index.php?/api/v2/get_cases/34&suite_id=2&priority_id=3,4 - プロジェクト 34 から 10 個のテスト ケースを取得する場合
GET index.php?/api/v2/get_cases/34&limit=10 - プロジェクト 34 の指定されたオフセットからのテスト ケースだけを取得する場合
GET index.php?/api/v2/get_cases/34&offset=5 - フィルター文字列 “login”を使用してプロジェクト 34 のケースをフィルタリングする場合
GET index.php?/api/v2/get_cases/34&filter=login - 使用例の組み合わせ
GET index.php?/api/v2/get_cases/34&offset=5&limit=10&filter=login
- プロジェクト 34 (プロジェクト ID が 34) の ID が 2 のスイートにある、優先度が 3 または 4 のすべてのテスト ケースを取得する場合