ページを選択

テスト

テスト (特定のテスト ランまたはテスト計画に追加されたテスト ケースの個々のインスタンス) に関する情報を取得するには、次の API メソッドを使用します 。

get_test

既存のテストを返します。

GET index.php?/api/v2/get_test/{test_id}

パラメーター

名前 タイプ 必須 説明
test_id integer true テストの ID
テストではなくテスト結果について知るには、get_resultsを参照してください。

リクエスト フィルター

名前 タイプ 説明
with_data string データを取得するためのパラメーター

レスポンスの内容

レスポンスの例

{
    "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,
    "labels": [
      {
       "id": 1,
       "title": "label1",
       },
      {
       "id": 2,
       "title": "label2",
      }
   ]
}

レスポンスには次のシステム項目が常に含まれています。

名前 タイプ 説明
assignedto_id integer テストが割り当てられたユーザーの ID
case_id integer 関連するテスト ケースの ID
estimate timespan 関連するテスト ケースの見積り。例えば “30s” や “1m 45s”
estimate_forecast timespan 関連するテスト ケースの予想見積り。例えば “30s” や “1m 45s”
id integer テストの一意の ID
milestone_id integer テスト ケースにリンクされているマイルストーンの ID
priority_id integer テスト ケースにリンクされている優先度の ID
refs string テスト ケースにリンクされている参照/要件のカンマ区切りリスト
run_id integer テストが所属する テスト ラン の ID
status_id integer テストの現在のステータス ID。get_statuses も参照。
title string 関連するテスト ケースのタイトル
type_id integer テスト ケースにリンクされているテスト ケース タイプの ID
レスポンスにはテスト ケースのカスタム フィールドも含まれており、先頭に ‘custom_’ を付けたシステム名がフィールド名として使用されます。利用可能なカスタム フィールド タイプの一覧は add_case を参照してください。

レスポンス コード

ステータス コード 説明
200 成功。テストがレスポンスの一部として返されます
400 無効または不明なテスト
403 プロジェクトにアクセスできない
429 TestRail Cloud のみ – リクエストが多すぎます

get_tests

1 つの テスト ラン に対するテストのリストを返します。

GET index.php?/api/v2/get_tests/{run_id}

パラメーター

名前 タイプ 必須 説明
run_id integer true テスト ランの ID
テストでは無くテスト結果について知るには、get_results を参照してください。

リクエスト フィルター

リクエスト URL の query パラメーターを使用して、以下のフィルターを適用できます。

名前 タイプ 説明
status_id integer (list) フィルタリングするステータス ID のカンマ区切りリスト。
limit integer レスポンスに表示されるテスト数の上限 (任意パラメーター。デフォルトのレスポンス サイズは 250) (TestRail 6.7 以降が必要)
offset integer (list) レスポンスが開始する位置を示す数値 (任意パラメーター) (TestRail 6.7 以降が必要)。
label_id integer (list) フィルタリングするラベル ID のカンマ区切りリスト。
# All test cases for test run with ID 1 and status 4, 5 (Retest and Failed)
GET index.php?/api/v2/get_tests/1&offset=1&limit=30&status_id=4,5

レスポンスの内容

レスポンスにはテストの配列が含まれます。リスト内の各テストの形式は、get_test と同じです。

{
    "offset": 0,
    "limit": 250,
    "size": 236,
    "_links": {
        "next": null,
        "prev": null,
    },
    "tests": [
        {
            "id": 1,
            "title": "Test conditional formatting with basic value range",
        },
        {
            "id": 2,
            "title": "Verify line spacing on multi-page document",
        },
    ]
}

レスポンス コード

ステータス コード 説明
200 成功。テストがレスポンスの一部として返されます
400 無効または不明なテスト ラン
403 プロジェクトにアクセスできない
429 TestRail Cloud のみ – リクエストが多すぎます

update_test

既存のテストに割り当てられたラベルを更新します。

POST index.php?/api/v2/update_test/{test_id}

パラメーター

名前 タイプ 必須 説明
test_id integer true 更新するテストの ID
labels Array of mixed values (integer or string) true 配列形式のラベルの ID、ラベルのタイトル、またはその両方。

リクエストの例

{
    "labels": [1,2]
}

レスポンスの内容

レスポンスにはテストの配列が含まれます。リスト内の各テストの形式は、get_test と同じです。

{
  "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,
  "labels": [
   {
    "id": 1,
    "title": "label1",
    },
   {
    "id": 2,
    "title": "label2",
    }
  ]
}

レスポンスコード

ステータス コード 説明
200 成功。テストがレスポンスの一部として返されます
400 無効なラベル
403 プロジェクトにアクセスできない
429 TestRail Cloud のみ – リクエストが多すぎます (API レート制限) を参照

update_tests

複数のテストに割り当てられたラベルを同じ値で更新します。テストごとに異なるラベルを持つ複数のテストの更新はサポートしていません。

POST index.php?/api/v2/update_tests

パラメーター

名前 タイプ 必須 説明
test_ids integer true 更新するテストの ID
labels Array of mixed values (integer or string) true 配列形式のラベルの ID、ラベルのタイトル、またはその両方。

リクエストの例

{
    "test_ids": [1, 2, 3],
    "labels": [1,2]
}

レスポンスの内容

レスポンスにはテストの配列が含まれます。リスト内の各テストの形式は、get_test と同じです。

レスポンス コード

ステータス コード 説明
200 成功。テストがレスポンスの一部として返されます
400 無効なラベル
403 プロジェクトにアクセスできない
429 TestRail Cloud のみ – リクエストが多すぎます (API レート制限) を参照