テスト ラン

テスト ラン に関する情報を取得したり、テスト ラン を作成または変更するには、次の API メソッドを使用します。  

get_run

既存の テスト ラン を返します。テスト ラン に含まれるテストのリストについては、get_tests を参照してください。

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

パラメーター

リクエストの例

# Get the test run with an ID of 42
GET index.php?/api/v2/get_run/42

レスポンスの内容

レスポンスの例

{
    "assignedto_id": 6,
    "blocked_count": 0,
    "completed_on": null,
    "config": "Firefox, Ubuntu 12",
    "config_ids": [
        2,
        6
    ],
    "created_by": 1,
    "created_on": 1393845644,
    "refs": "SAN-1",
    "custom_status1_count": 0,
    "custom_status2_count": 0,
    "custom_status3_count": 0,
    "custom_status4_count": 0,
    "custom_status5_count": 0,
    "custom_status6_count": 0,
    "custom_status7_count": 0,
    "description": null,
    "failed_count": 2,
    "id": 81,
    "include_all": false,
    "is_completed": false,
    "milestone_id": 7,
    "name": "File Formats",
    "passed_count": 2,
    "plan_id": 80,
    "project_id": 1,
    "retest_count": 1,
    "suite_id": 4,
    "untested_count": 3,
    "updated_on": null,
    "url": "http://{server}/testrail/index.php?/runs/view/81"
}

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

レスポンスコード

get_runs

プロジェクトのテスト ランのリストを返します。テスト計画 (get_plans/get_plan を参照) の一部ではない テスト ラン だけを返します。

GET index.php?/api/v2/get_runs/{project_id}

パラメーター

このメソッドは、最大で 250 のエントリを含むレスポンス配列を返します。それ以上のエントリを取得するには、下のリクエスト フィルター セクションで説明されているオフセット フィルターを使用して追加のリクエストを行います。

リクエスト フィルター

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

# All active test runs for project with ID 1 created by user with ID 1 or 2
GET index.php?/api/v2/get_runs/1&is_completed=0&created_by=1,2

レスポンスの内容

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

{
    "offset": 0,
    "limit": 250,
    "size": 250,
    "_links": {
        "next": "/api/v2/get_cases/1&limit=250&offset=250",
        "prev": null
    },
    "runs": [
        {
            "id": 1,
            "name": "Test run 1",
        },
        {
            "id": 2,
            "name": "Test run 2",
        },
    ]
}

レスポンス コード

add_run

新規テスト ランを作成します。

POST index.php?/api/v2/add_run/{project_id}

リクエスト ボディ

リクエスト ボディ メッセージで以下のフィルターを適用できます。

リクエストの例

カスタム テスト ケース選択を含む新しいテスト ランを作成する方法を示す次の例も参照してください。

{
    "suite_id": 1,
    "name": "This is a new test run",
    "assignedto_id": 5,
    "refs": "SAN-1, SAN-2",
    "include_all": false,
    "case_ids": [1, 2, 3, 4, 7, 8]
}

レスポンスの内容

成功した場合、このメソッドは get_run と同じレスポンス形式を使用して新しい テスト ラン を返します。

レスポンス コード

update_run

既存の テスト ランを更新します (部分的な更新がサポートされています。つまり、特定のフィールドのみを送信して更新できます)。

テスト計画内のテストを更新する方法は テスト計画 API を参照してください。

POST index.php?/api/v2/update_run/{run_id}

パラメーター

suite_id および assignedto_id フィールドを除いて、このメソッドは add_run と同じ POST フィールドをサポートします。

リクエストの例

テストランの説明とテスト ケースの選択を更新する方法を示す次の例も参照してください。

{
    "description": "A description for the test run",
    "include_all": true
}

次の例では、選択したテストケースを使用するようにテスト ランを更新します。

{
    "include_all": false,
    "case_ids": [1, 2, 3, 5, 8]
}

レスポンスの内容

成功した場合、このメソッドは get_run と同じレスポンス形式を使用して更新されたテスト ランを返します。

レスポンス コード

close_run

POST index.php?/api/v2/close_run/{run_id}

レスポンスの内容

POST index.php?/api/v2/delete_run/{run_id}

レスポンス コード