API: テスト
テストに関する情報を取得するには、次の API メソッドを使用します。
get_test
既存のテストを返します。
GET index.php?/api/v2/get_test/:test_id
:test_id | テストの ID |
テストではなくテスト結果について知るには、get_results を参照してください。
レスポンスの内容
典型的なレスポンスについては、下記を参照してください。
{ "assignedto_id": 1, "case_id": 1, "custom_expected": "..", "custom_preconds": "..", "custom_steps_separated": [ { "content": "Step 1", "expected": "Expected Result 1" }, { "content": "Step 2", "expected": "Expected Result 2" } ], "estimate": "1m 5s", "estimate_forecast": null, "id": 100, "priority_id": 2, "run_id": 1, "status_id": 5, "title": "Verify line spacing on multi-page document", "type_id": 4 }
レスポンスには次のシステム項目が常に含まれています。
名前 | タイプ | 説明 |
---|---|---|
assignedto_id | int | テストが割り当てられるユーザーの ID |
case_id | int | 関連するテスト ケースの ID |
estimate | timespan | 関連するテスト ケースの見積り。例えば “30s” や “1m 45s” |
estimate_forecast | timespan | 関連するテスト ケースの予想見積り。例えば “30s” や “1m 45s” |
id | int | テストの一意の ID |
milestone_id | int | テスト ケースにリンクされているマイルストーンの ID |
priority_id | int | テスト ケースにリンクされている優先度の ID |
refs | string | テスト ケースにリンクされている参照/要件のカンマ区切りリスト |
run_id | int | テストが所属する テスト ラン の ID |
status_id | int | テストの現在のステータス ID。get_statuses も参照。 |
title | string | 関連するテスト ケースのタイトル |
type_id | int | テスト ケースにリンクされているテスト ケース タイプの ID |
レスポンスにはテスト ケースのカスタム フィールドも含まれており、先頭に ‘custom_’ を付けたシステム名がフィールド名として使用されます。利用可能なカスタム フィールド タイプの一覧は add_case を参照してください。
レスポンス コード
200 | 成功。テストがレスポンスの一部として返されます |
400 | 無効または不明なテスト ID です |
403 | プロジェクトにアクセスできません |
get_tests
1 つの テスト ラン に対するテストのリストを返します。
GET index.php?/api/v2/get_tests/:run_id
:run_id | テスト ラン の ID |
テストではなくテスト結果を取得するには、get_results を参照してください。
リクエスト フィルター
以下のフィルターを適用できます。
名前 | タイプ | 説明 |
---|---|---|
:status_id | int (list) | フィルタリングするステータス ID のカンマ区切りリスト。 |
:limit | int | レスポンスに表示されるテスト数の上限 (任意パラメーター。デフォルトのレスポンス サイズは 250) (TestRail 6.7 以降が必要) |
:offset | int | レスポンスの開始する位置 (任意パラメーター) (TestRail 6.7 以降が必要) |
# All test cases for test run with ID 1 and status 4, 5 (Retest and Failed) GET index.php?/api/v2/get_tests/1&status_id=4,5
レスポンスの内容
レスポンスにはテストの配列が含まれます。リスト内の各テストの形式は、get_test と同じです。
[ { "id": 1, "title": "Test conditional formatting with basic value range", .. }, { "id": 2, "title": "Verify line spacing on multi-page document", .. }, .. ]
注意: 2021 年 2 月 26日から、一括 GET API エンドポイントが返すデータの構造が変更されます。これらの一括エンドポイントは、すべてのエントリの配列ではなく、追加のページ分割フィールドを持つオブジェクトと、250 エンティティまでの配列を返します。新しいレスポンス構造を確認し、必要に応じたコードの変更をテストするには、API リクエストに次のヘッダーと値を含めます: x-api-ident: beta
新しいレスポンスの内容
レスポンスにはテストの配列が含まれます。リスト内の各テストの形式は、get_test と同じです。
{ "offset": 0, "limit": 250, "size": 236, "_links": { "next": null, "prev": null, }, "test": [ { "id": 1, "title": "Test conditional formatting with basic value range", .. }, { "id": 2, "title": "Verify line spacing on multi-page document", .. }, .. ] }
レスポンス コード
200 | 成功。テストがレスポンスの一部として返されます |
400 | 無効または不明な テスト ラン ID です |
403 | プロジェクトにアクセスできません |