API:テスト ケース

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

get_case

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

GET index.php?/api/v2/get_case/:case_id

レスポンスの内容

典型的なレスポンスについては、次のサンプルを参照してください。

{
    "created_by": 5,
    "created_on": 1392300984,
    "custom_expected": "..",
    "custom_preconds": "..",
    "custom_steps": "..",
    "custom_steps_separated": [
        {
            "content": "Step 1",
            "expected": "Expected Result 1"
        },
        {
            "content": "Step 2",
            "expected": "Expected Result 2"
        }
    ],
    "estimate": "1m 5s",
    "estimate_forecast": null,
    "id": 1,
    "milestone_id": 7,
    "priority_id": 2,
    "refs": "RF-1, RF-2",
    "section_id": 1,
    "suite_id": 1,
    "title": "Change document attributes (author, title, organization)",
    "type_id": 4,
    "updated_by": 1,
    "updated_on": 1393586511
}

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

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

レスポンス コード

get_cases

テスト スイートまたはテスト スイート内の特定のセクションに含まれるテスト ケースのリストを返します (プロジェクトが複数のスイートを有効化している場合)。

GET index.php?/api/v2/get_cases/:project_id&suite_id=:suite_id

リクエスト フィルター

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

レスポンスの内容

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

[ 
    { "id": 1, "title": "..", .. }, 
    { "id": 2, "title": "..", .. },
    .. 
]

新しいレスポンスの内容

レスポンスにはテスト ケースの配列が含まれます。各テスト ケースのフォーマットは get_case と同じです。

{
    "offset": 0,
    "limit": 250,
    "size": 250,
    "_links": {
        "next": "/api/v2/get_cases/1&limit=250&offset=250",
        "prev": null
    },
    "cases": [
        {
            "id": 1,
            "title": "..", ..
        },
        {
            "id": 2,
            "title": "..", ..
        },
      ..
    ]
}

レスポンス コード

get_history_for_case

test case_id の編集履歴を返します。

TestRail 6.5.4 以降が必要です。

GET index.php?/api/v2/get_history_for_case/:case_id

リクエスト フィルター

以下のリストを適用できます。

レスポンス フィールド

以下のフィールドが返されます。

changes 配列には以下のフィールドが含まれる可能性があります。

レスポンスの内容

レスポンスにはテスト ケースの変更の配列が含まれます。配列の各エントリは変更レコードです。

[
    {
        "id": 3382,
        "type_id": 6,
        "created_on": 1597927176,
        "user_id": 1,
        "changes": [
            {
                "type_id": 1,
                "old_text": "Original Section",
                "new_text": "Updated Section",
                "field": "section_id",
                "old_value": 3573,
                "new_value": 3574
            }
        ]
    },
    {
        "id": 3389,
        "type_id": 6,
        "created_on": 1597932715,
        "user_id": 1,
        "changes": [
            {
                "type_id": 1,
                "field": "refs",
                "old_value": null,
                "new_value": "1"
            }
        ]
    },
    ...
]

新しいレスポンスの内容

レスポンスにはテスト ケースの変更の配列が含まれます。各エントリは変更レコードです。

[
    {
        "offset": 0,
        "limit": 250,
        "size": 1,
        "_links": {
            "next": null,
            "prev": null
        },
        "history": [
            {
                "id": 3382,
                "type_id": 6,
                "created_on": 1597927176,
                "user_id": 1,
                "changes": [
                    {
                        "type_id": 1,
                        "old_text": "Original Section",
                        "new_text": "Updated Section",
                        "field": "section_id",
                        "old_value": 3573,
                        "new_value": 3574
                    }
                    {...
                    },
                    ...
                ]
            },
            {
                "id": 3389,
                "type_id": 6,
                "created_on": 1597932715,
                "user_id": 1,
                "changes": [
                    {
                        "type_id": 1,
                        "field": "refs",
                        "old_value": null,
                        "new_value": "1"
                    }
                ]
            },
            ...
        ]
    }
]

レスポンス コード

add_case

新規テストケースを作成します。

POST index.php?/api/v2/add_case/:section_id

リクエスト フィールド

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

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

{
    ..
    "custom_preconds": "These are the preconditions for a test case"
    ..
}

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

リクエストの例

構造化ステップ カスタム フィールドを使用してステップを送信する方法を示す次の例も参照してください。

{
    "title": "This is a test case",
    "type_id": 1,
    "priority_id": 3,
    "estimate": "3m",
    "refs": "RF-1, RF-2",

    ..

    "custom_steps_separated": [
        {
            "content": "Step 1",
            "expected": "Expected Result 1"
        },
        {
            "content": "Step 2",
            "expected": "Expected Result 2"
        },

        ..
    ]

    ..
}

レスポンスの内容

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

レスポンス コード

copy_cases_to_section

テスト ケースのリストを別のスイート/セクションにコピーします。

POST index.php?/api/v2/copy_cases_to_section/:section_id

リクエスト フィールド

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

レスポンスコード

update_case

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

POST index.php?/api/v2/update_case/:case_id

このメソッドは add_case と同じ POST フィールドをサポートします。テスト ケースの section_id を更新するには、TestRail 6.5.2 以降が必要です。

リクエストの例

テスト ケースの優先順位フィールドと見積りフィールドを更新する方法を示す次の例も参照してください。

{
    "priority_id": 1,
    "estimate": "5m"
}

レスポンスの内容

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

レスポンス コード

update_cases

テスト ケースのセットに高い優先度を設定する場合など、複数のテスト ケースを同じ値で更新します。複数のテスト ケースをテスト ケースごとに異なる値で更新することはできません。

POST index.php?/api/v2/update_cases/:project_id&suite_id=X

メソッドは add_case と同じ POST フィールドをサポートしています。ケースの section_id を更新するには、TestRail 6.5.2 以降が必要です。

リクエストの例

テスト ケースの優先順位フィールドと見積りフィールドを更新する方法を示す次の例も参照してください。

{
    "priority_id": 1,
    "estimate": "5m"
}

レスポンスの内容

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

レスポンス コード

move_cases_to_section

テスト ケースを別のスイートまたはセクションに移動します。

POST index.php?/api/v2/move_cases_to_section/:section_id

リクエスト フィールド

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

レスポンス コード

delete_case

既存のテスト ケースを削除します。

POST index.php?/api/v2/delete_case/:case_id

Soft パラメーター

soft=1 の場合、影響を受けるテストの数に関するデータを返します。

soft=1 の場合、エンティティは実際には削除されません。

レスポンス コード

delete_cases

プロジェクトまたはテスト スイートの複数のテスト ケースを削除します。

POST index.php?/api/v2/delete_cases/:project_id&suite_id&soft=1

リクエストの例

選択されたプロジェクトのケース ID を表示する次の例も参照してください。

{
    "case_ids": [1,2,3,...]
}

レスポンス コード