テストケース

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

get_case

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

GET index.php?/api/v2/get_case/{case_id}

パラメーター

名前	タイプ	必須	説明
case_id	integer	true	テストケースの ID

リクエストの例

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

レスポンスの内容

レスポンスの例

{
    "id": 1,
    "title": "Print document history and attributes",
    "section_id": 1,
    "template_id": 1,
    "type_id": 2,
    "priority_id": 2,
    "milestone_id": null,
    "refs": null,
    "created_by": 1,
    "created_on": 1646317844,
    "updated_by": 1,
    "updated_on": 1646317844,
    "estimate": null,
    "estimate_forecast": "8m 40s",
    "suite_id": 1,
    "display_order": 1,
    "is_deleted": 0,
    "custom_automation_type": 0,
    "custom_preconds": null,
    "custom_steps": null,
    "custom_expected": null,
    "custom_steps_separated": null,
    "custom_mission": null,
    "custom_goals": null
}

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

名前	タイプ	説明
created_by	integer	テストケースを作成したユーザーの ID
created_on	timestamp	テストケースが作成された日時 (UNIX タイムスタンプ)
estimate	timespan	見積り時間。例: “30s” や “1m 45s”
estimate_forecast	timespan	予想見積り時間。例: “30s” や “1m 45s”
id	integer	テストケースの一意の ID
milestone_id	integer	テストケースにリンクされているマイルストーンの ID
priority_id	integer	テストケースにリンクされている優先度の ID
refs	string	テストケースにリンクされている参照/要件のカンマ区切りリスト
section_id	integer	テストケースが所属するセクションの ID
suite_id	integer	テストケースが所属するテストスイートの ID
template_id	integer	テストケースが使用するテンプレート (フィールドレイアウト) の ID (TestRail 5.2 以降が必要)
title	string	テストケースのタイトル
type_id	integer	テストケースにリンクされているテストケースタイプの ID
updated_by	integer	テストケースを最後に更新したユーザーの ID
updated_on	timestamp	テストケースが最後に更新された日時 (UNIX タイムスタンプ)

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

レスポンスコード

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

get_cases

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

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

パラメーター

名前	タイプ	必須	説明
project_id	integer	true	プロジェクトの ID
suite_id	integer	説明を参照	テストスイートの ID (プロジェクトがシングルスイートモードで動作している場合はオプション)
created_after	timestamp	false	この日付以降に作成されたテストケースのみを返す (UNIX タイムスタンプ)
created_before	timestamp	false	この日付以前に作成されたテストケースのみを返す (UNIX タイムスタンプ)
created_by	integer (list)	false	フィルタリングする作成者 (ユーザー ID) のカンマ区切りリスト。
filter	string	false	ケースのタイトルにフィルターと一致する文字列を含むケースだけを返す。
limit	integer	false	レスポンスが返すテストケースの数 (デフォルトのレスポンスのサイズは 250) (TestRail 6.7 以降が必要)
milestone_id	integer (list)	false	フィルタリングするマイルストーン ID のカンマ区切りリスト (マイルストーンフィールドがプロジェクトで無効化されている場合は使用できません)。
offset	integer	false	テストケースのカウントを開始する位置 (オフセット) (TestRail 6.7 以降が必要)
priority_id	integer (list)	false	フィルタリングする優先度 ID のカンマ区切りリスト。
refs	string	false	単一の参照 ID (例: TR-1, 4291, など) (TestRail 6.5.2 以降が必要)
section_id	integer	false	テストケースセクションの ID
template_id	integer (list)	false	フィルタリングするテンプレート ID のカンマ区切りリスト (TestRail 5.2 以降が必要)
type_id	integer (list)	false	フィルタリングするタイプ ID のカンマ区切りリスト。
updated_after	timestamp	false	この日付以降に更新されたテストケースのみを返す (UNIX タイムスタンプ)
updated_before	timestamp	false	この日付以前に更新されたテストケースのみを返す (UNIX タイムスタンプ)
updated_by	integer	false	フィルタリングするテストケースを更新したユーザーのカンマ区切りリスト

リクエストの例

# Get all the test cases that are in project 34 (project ID of 34), suite with ID of 2 and priority 3 or 4
GET index.php?/api/v2/get_cases/34&suite_id=2&priority_id=3,4

# Get 10 test cases from project 34
GET index.php?/api/v2/get_cases/34&limit=10

# Only returning test cases from project 34 starting the offset number
GET index.php?/api/v2/get_cases/34&offset=5

# Filter cases in project 34 with a filter string of "login"
GET index.php?/api/v2/get_cases/34&filter=login

# Combined usage
GET index.php?/api/v2/get_cases/34&offset=:5&limit=:10&filter=:login

レスポンスの内容

レスポンスにはテストケースの配列が含まれます。cases オブジェクト内の各テストケースの形式は、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": "..",
        }
    ]
}

レスポンスコード

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

get_history_for_case

TestRail 6.5.4 以降が必要です。

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

GET index.php?/api/v2/get_history_for_case/{case_id}

パラメーター

名前	タイプ	必須	説明
case_id	integer	true	テストケースの ID
limit	integer	false	レスポンスが返すテストケース変更の数 (デフォルトのレスポンスのサイズは 250) (TestRail 6.7 以降が必要)
offset	integer	false	テストケース変更のカウントを開始する位置 (オフセット) (TestRail 6.7 以降が必要)

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

名前	タイプ	説明
id	integer	テストケース変更の ID
created_on	timestamp	変更が行われたときの UNIX タイムスタンプ
type_id	integer	変更タイプ。多くの場合は「更新」を表す 6 (changes 配列の type_id 値は下で説明)。
user_id	integer	変更を実施したユーザー名
changes	array	テストケースに加えられた変更の詳細の配列

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

名前	タイプ	説明
type_id	integer	更新されたフィールドのタイプ 1 = string 2 = integer 3 = boolean 4 = date 5 = timespan 6 = text 7 = URL 8 = steps
old_text	text	更新されたフィールドの以前のテキスト値 (テキストフィールドの場合)。
new_text	text	更新されたフィールドの新しいテキスト値 (テキストフィールドの場合)。
label	string	ユーザーインターフェイスに表示されるフィールドラベル
options	array	必須、デフォルト値など、フィールドに設定されたオプションの配列
field	string	更新されたフィールドのシステム名
old_value	varies	更新されたフィールドの以前の値。個別の手順フィールドを含め、テキストフィールド以外のフィールドの場合に使用されます。値はフィールドタイプに応じてテキストまたは整数です。
new_value	varies	更新されたフィールドの新しい値。個別の手順フィールドを含め、テキストフィールド以外のフィールドの場合に使用されます。値はフィールドタイプに応じてテキストまたは整数です。

レスポンスの内容

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

[
    {
        "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"
                    },
                ]
            },
        ]
    }
]

レスポンスコード

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

add_case

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

POST index.php?/api/v2/add_case/{section_id}

パラメーター

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

名前	タイプ	必須	説明
section_id	integer	true	テストケースを追加するセクションの ID
title	string	true	テストケースのタイトル
template_id	integer	false	テンプレート (フィールドレイアウト) の ID (TestRail 5.2 以降が必要)
type_id	integer	false	テストケースタイプの ID
priority_id	integer	false	テストケース優先度の ID
estimate	timespan	false	見積り時間。例: “30s” や “1m 45s”
milestone_id	integer	false	テストケースをリンクするマイルストーンの ID
refs	string	false	参照/要件のカンマ区切りのリスト

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

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

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

名前	タイプ	説明
Checkbox	boolean	オンの場合は true、オフの場合は false
Date	string	TestRail および API ユーザー用に設定されたのと同じ形式の日付 (例 “07/08/2013”)
Dropdown	integer	フィールド設定で設定されたドロップダウン値の ID
Integer	integer	有効な整数
Milestone	integer	カスタムフィールドのマイルストーンの ID
Multi-select	array	フィールド設定で設定された ID の配列
Steps	array	ステップを指定するオブジェクトの配列。下の例も参照してください。
String	string	最大 250 文字までの有効な文字列
Text	string	長さの制限がない文字列
URL	string	URL の構文と一致する文字列
User	integer	カスタムフィールドのユーザーの ID

リクエストの例

個別のテスト手順を使用してステップを送信する方法を示す次の例も参照してください。

{
    "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"
        },
        {
            "shared_step_id": 3
        },
    ]
}

レスポンスの内容

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

{
    "id": 1,
    "title": "Print document history and attributes",
    "section_id": 1,
    "template_id": 1,
    "type_id": 2,
    "priority_id": 2,
    "milestone_id": null,
    "refs": null,
    "created_by": 1,
    "created_on": 1646317844,
}

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

名前	タイプ	説明
created_by	integer	テストケースを作成したユーザーの ID
created_on	timestamp	テストケースが作成された日時 (UNIX タイムスタンプ)
estimate	timespan	見積り時間。例: “30s” や “1m 45s”
estimate_forecast	timespan	予想見積り時間。例: “30s” や “1m 45s”
id	integer	テストケースの一意の ID
milestone_id	integer	テストケースにリンクされているマイルストーンの ID
priority_id	integer	テストケースにリンクされている優先度の ID
refs	string	テストケースにリンクされている参照/要件のカンマ区切りリスト
section_id	integer	テストケースが所属するセクションの ID
suite_id	integer	テストケースが所属するテストスイートの ID
template_id	integer	テストケースが使用するテンプレート (フィールドレイアウト) の ID (TestRail 5.2 以降が必要)
title	string	テストケースのタイトル
type_id	integer	テストケースにリンクされているテストケースタイプの ID
updated_by	integer	テストケースを最後に更新したユーザーの ID
updated_on	timestamp	テストケースが最後に更新された日時 (UNIX タイムスタンプ)

レスポンスコード

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

copy_cases_to_section

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

POST index.php?/api/v2/copy_cases_to_section/{section_id}

パラメーター

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

名前	タイプ	必須	説明
section_id	integer	true	テストケースのコピー先セクションの ID
case_ids	array of integers	false	カンマ区切りのテストケース ID のリスト

レスポンスコード

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

update_case

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

POST index.php?/api/v2/update_case/{case_id}

パラメーター

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

名前	タイプ	必須	説明
case_id	integer	true	テストケースの ID
section_id	integer	false	テストケースを更新するセクションの ID
title	string	false	テストケースのタイトル
template_id	integer	false	テンプレート (フィールドレイアウト) の ID (TestRail 5.2 以降が必要)
type_id	integer	false	テストケースタイプの ID
priority_id	integer	false	テストケース優先度の ID
estimate	timespan	false	見積り時間。例: “30s” や “1m 45s”
milestone_id	integer	false	テストケースをリンクするマイルストーンの ID
refs	string	false	参照/要件のカンマ区切りのリスト

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

リクエストの例

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

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

レスポンスの内容

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

レスポンスコード

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

update_cases

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

POST index.php?/api/v2/update_cases/{suite_id}

パラメーター

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

名前	タイプ	必須	説明
case_ids	array of integers	true	更新するケースの ID
suite_id	integer	説明を参照	テストスイートの ID (プロジェクトがシングルスイートモードで動作している場合はオプション)
section_id	integer	false	テストケースを更新するセクションの ID
title	string	false	テストケースのタイトル
template_id	integer	false	テンプレート (フィールドレイアウト) の ID (TestRail 5.2 以降が必要)
type_id	integer	false	テストケースタイプの ID
priority_id	integer	false	テストケース優先度の ID
estimate	timespan	false	見積り時間。例: “30s” や “1m 45s”
milestone_id	integer	false	テストケースをリンクするマイルストーンの ID
refs	string	false	参照/要件のカンマ区切りのリスト

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

リクエストの例

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

{
    "case_ids": [1, 2, 3],
    "priority_id": 1,
    "estimate": "5m"
}

レスポンスの内容

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

レスポンスコード

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

move_cases_to_section

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

POST index.php?/api/v2/move_cases_to_section/{section_id}

パラメーター

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

名前	タイプ	必須	説明
section_id	integer	true	テストケースの移動先セクションの ID
suite_id	integer	true	テストケースの移動先スイートの ID
case_ids	array of integers	true	カンマ区切りのテストケース ID のリスト

レスポンスコード

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

delete_case

削除したテストケースを元に戻すことはできず、アクティブなテストラン (まだ閉じられていない (アーカイブされていない) テストラン) 内のすべてのテスト結果も永久に削除されます。

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

POST index.php?/api/v2/delete_case/{case_id}

パラメーター

名前	タイプ	必須	説明
case_id	integer	true	テストケースの ID
soft	integer	false	soft=1 の場合、削除されるデータに関する情報を返し、削除は実行しません。

Soft パラメーター

soft パラメーターを省略した場合、または soft=0 をサブミットした場合、テストケースは削除されます。

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

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

レスポンスコード

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

delete_cases

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

POST index.php?/api/v2/delete_cases/{suite_id}&soft=1

パラメーター

名前	タイプ	必須	説明
case_ids	array of integers	true	削除するテストケースの ID の配列
project_id	integer	true	プロジェクトの ID
suite_id	integer	説明を参照	テストスイートの ID (プロジェクトが複数スイートモードの場合のみ必須)
soft	integer	false	soft=1 の場合、削除されるデータに関する情報を返し、削除は実行しません。

リクエストの例

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

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

レスポンスコード

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

テスト ケース

get_case

パラメーター

レスポンスの内容

レスポンス コード

get_cases

パラメーター

レスポンスの内容

レスポンス コード

get_history_for_case

パラメーター

レスポンスの内容

レスポンス コード

add_case

パラメーター

リクエストの例

レスポンスの内容

レスポンス コード

copy_cases_to_section

パラメーター

レスポンス コード

update_case

パラメーター

リクエストの例

レスポンスの内容

レスポンス コード

update_cases

パラメーター

リクエストの例

レスポンスの内容

レスポンス コード

move_cases_to_section

パラメーター

レスポンス コード

delete_case

パラメーター

Soft パラメーター

レスポンス コード

delete_cases

パラメーター

リクエストの例

レスポンス コード

目次

レスポンスコード

レスポンスコード

レスポンスコード

レスポンスコード

レスポンスコード

レスポンスコード

レスポンスコード

レスポンスコード

レスポンスコード

レスポンスコード