API: 結果

get_results

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

GET index.php?/api/v2/get_results/:test_id

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

リクエスト フィルター

以下のフィルターを適用できます。

レスポンスの内容

典型的なレスポンスについては、下記を参照してください。

[
    {
        "assignedto_id": 1,
        "comment": "This test failed: ..",
        "created_by": 1,
        "created_on": 1393851801,
        "custom_step_results: [
        {
            ..
            },
        ..
        ]
        "defects": "TR-1",
        "elapsed": "5m",
        "id": 1,
        "status_id": 5,
        "test_id": 1,
        "version": "1.0RC1"
    },
    ..
]

新しいレスポンスの内容

典型的なレスポンスについては、下記を参照してください。

{
    "offset": 0,
    "limit": 250,
    "size": 250,
    "_links": {
        "next": "/api/v2/get_results/131071&limit=250&offset=250",
        "prev": null
    },
    "results": [
        {
            "assignedto_id": 1,
            "comment": "This test failed: ..",
            "created_by": 1,
            "created_on": 1393851801,
            "custom_step_results: [
                {
                    ..
                },
                ..
            ]
            "defects": "TR-1",
            "elapsed": "5m",
            "id": 1,
            "status_id": 5,
            "test_id": 1,
            "version": "1.0RC1"
        },
        ..
    ]
}

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

レスポンスにはカスタム フィールドも含まれており、先頭に ‘custom_’ を付けたシステム名がフィールド名として使用されます。利用可能なカスタム フィールド タイプの一覧は add_result を参照してください。

レスポンス コード

get_results_for_case

1 つの テスト ラン とテスト ケースの組み合わせに対する結果のリストを返します。

get_results との違いは、このメソッドはテスト ケースではなく テスト ラン とテスト ケースの組み合わせを受け取ることです。TestRailでは、テストは テスト ラン の一部であり、テスト ケースは関連するテスト スイートの一部です。そのため、新しい テスト ラン を作成すると、TestRail は テスト ラン のテスト スイートに含まれる各テスト ケースに対してテストを作成します。したがって、テストとは、テスト結果、コメント、およびテスト ステータスを持った、テスト ケースの「インスタンス」と考えることができます。テスト ケースとテストの違いの詳細については、TestRail の入門ガイドも参照してください。

GET index.php?/api/v2/get_results_for_case/:run_id/:case_id

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

リクエスト フィルター

以下のフィルターを適用できます。

レスポンスの内容

このメソッドは、get_results と同じレスポンス フォーマットを使用します。

レスポンス コード

get_results_for_run

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

GET index.php?/api/v2/get_results_for_run/:run_id

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

リクエスト フィルター

以下のフィルターを適用できます

レスポンスの内容

このメソッドは、get_results と同じレスポンス フォーマットを使用します。

レスポンス コード

add_result

新しいテスト結果を追加したり、コメントを付けたり、テストを割り当てたりします。複数のテストに結果を追加する場合は、add_results を使用することをお勧めします。

POST index.php?/api/v2/add_result/:test_id

リクエスト フィールド

以下の POST フィールドがサポートされています (システムフィールド)。

カスタム フィールドもサポートされています。システム名の頭に ‘custom_’ を付けて送信します。例：

{
    ..
    "custom_comment": "This is a custom comment"
    ..
}

以下のカスタム フィールドタイプがサポートされています。

リクエストの例

構造化ステップを使用してステップの結果を送信する方法を示す次の例も参照してください。

{
    "status_id": 5,
    "comment": "This test failed",
    "elapsed": "15s",
    "defects": "TR-7",
    "version": "1.0 RC1 build 3724",
    ..,
    "custom_step_results": [
        {
            "content": "Step 1",
            "expected": "Expected Result 1",
            "actual": "Actual Result 1",
            "status_id": 1
        },
        {
            "content": "Step 2",
            "expected": "Expected Result 2",
            "actual": "Actual Result 2",
            "status_id": 2
        },
        ..
    ]
    ..
}

レスポンスの内容

成功した場合、このメソッドは、get_results と同じレスポンス形式を使用して、新しいテスト結果を返します。結果のリストではなく単一の結果を返します。

レスポンス コード

add_result_for_case

新しいテスト結果を追加したり、コメントを付けたり、テストを割り当てたりします (対象は テスト ラン とテスト ケースの組み合わせ)。複数のテスト ケースに結果を追加する場合は、add_results_for_cases を使用することをお勧めします。

add_result との違いは、このメソッドはテスト ケースではなく テスト ラン とテスト ケースの組み合わせを受け取ることです。TestRailでは、テストは テスト ラン の一部であり、テスト ケースは関連するテスト スイートの一部です。そのため、新しい テスト ラン を作成すると、TestRail は テスト ラン のテスト スイートに含まれる各テスト ケースに対してテストを作成します。したがって、テストとは、テスト結果、コメント、およびテスト ステータスを持った、テスト ケースの「インスタンス」と考えることができます。テスト ケースとテストの違いの詳細については、TestRail の入門ガイドも参照してください。

POST index.php?/api/v2/add_result_for_case/:run_id/:case_id

このメソッドは add_result と同じ POST フィールドをサポートします。

レスポンスの内容

成功した場合、このメソッドは、get_results と同じレスポンス形式を使用して、新しいテスト結果を返します。結果のリストではなく単一の結果を返します。

レスポンス コード

add_results

1 つまたはそれ以上の新しいテスト結果を追加したり、コメントを付けたり、1 つまたはそれ以上のテストを割り当てます。1 ステップで複数のテスト結果をまとめて追加するテスト自動化に最適です。

POST index.php?/api/v2/add_results/:run_id

このメソッドはテスト結果の配列を受け取ります (‘results’ フィールドで。詳細は以下を参照)。各テスト結果はテスト ID を指定する必要があり、add_result と同じフィールド、つまりテストに関連するすべてのシステム フィールドおよびカスタム フィールドを渡すことができます。

参照されるすべてのテストは、同じ テスト ラン に所属している必要があります。

リクエストの例

次のリストは典型的なリクエストの例を示しています。テストに加えて、結果ごとに少なくとも 1 つのステータス、コメント、または担当者フィールドを指定する必要があります。

{
    "results": [
        {
            "test_id": 101,
            "status_id": 5,
            "comment": "This test failed",
            "defects": "TR-7"
        },
        {
            "test_id": 102,
            "status_id": 1,
            "comment": "This test passed",
            "elapsed": "5m",
            "version": "1.0 RC1"
        },

        ..

       {
            "test_id": 101,
            "assignedto_id": 5,
            "comment": "Assigned this test to Joe"
        },

       ..
    ]
}

レスポンスの内容

成功した場合、このメソッドは、get_results と同じレスポンス形式を使用して、リクエストのリストと同じ順序で新しいテスト結果を返します。

レスポンス コード

add_results_for_cases

1 つまたはそれ以上の新しいテスト結果を追加したり、コメントを付けたり、1 つまたはそれ以上のテストを割り当てます (テスト ケース ID を使用)。1 ステップで複数のテスト結果をまとめて追加するテスト自動化に最適です。

POST index.php?/api/v2/add_results_for_cases/:run_id

このメソッドはテスト結果の配列を受け取ります (‘results’ フィールドで。詳細は以下を参照)。各テスト結果はテスト ケース ID を指定する必要があり、add_result と同じフィールド、つまりテストに関連するすべてのシステム フィールドおよびカスタム フィールドを渡すことができます。

add_results との違いは、このメソッドはテスト ID ではなくテスト ケース ID を受け取ることです。詳細は add_result_for_case を参照してください。

参照されるすべてのテストは、同じ テスト ランに所属している必要があります。

リクエストの例

次のリストは典型的なリクエストの例を示しています。テスト ケースに加えて、結果ごとに少なくとも 1 つのステータス、コメント、または担当者フィールドを指定する必要があります。

{
    "results": [
        {
            "case_id": 1,
            "status_id": 5,
            "comment": "This test failed",
            "defects": "TR-7"
        },
        {
            "case_id": 2,
            "status_id": 1,
            "comment": "This test passed",
            "elapsed": "5m",
            "version": "1.0 RC1"
        },
        ..
        {
            "case_id": 1,
            "assignedto_id": 5,
            "comment": "Assigned this test to Joe"
        },
        ..
    ]
}

レスポンスの内容

レスポンス コード