ページを選択

API: テスト スイート

API: テスト スイート

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

get_suite

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

GET index.php?/api/v2/get_suite/:suite_id
:suite_id テスト スイートの ID

レスポンスの内容

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

{
    "description": "..",
    "id": 1,
    "name": "Setup & Installation",
    "project_id": 1,
    "url": "http://<server>/testrail/index.php?/suites/view/1"
}

レスポンスには次のフィールドが含まれています。

名前 タイプ 説明
completed_on timestamp テスト スイートがクローズされた日時 (UNIXタイムスタンプ) (TestRail 4.0 で追加)
description string テスト スイートの説明
id int テスト スイートの一意の ID
is_baseline bool テスト スイートがベースライン テスト スイートである場合は true、そうでない場合は false (TestRail 4.0で追加)
is_completed bool テスト スイートが完了/アーカイブ済みとしてマークされている場合は true、そうでない場合は false (TestRail 4.0で追加)
is_master bool テスト スイートがマスター テスト スイートである場合は true、そうでない場合は false (TestRail 4.0で追加)
name string テスト スイートの名前
project_id int テスト スイートが所属するプロジェクトの ID
url string ユーザー インターフェイスに表示されるテスト スイートのアドレス/URL

レスポンス コード

200 成功。テスト スイートがレスポンスの一部として返されます
400 無効または不明なテスト スイート ID です
403 プロジェクトにアクセスできません

get_suites

プロジェクトのテスト スイートのリストを返します。

GET index.php?/api/v2/get_suites/:project_id
:project_id プロジェクトの ID

レスポンスの内容

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

[
    { "id": 1, "name": "Setup & Installation", .. },
    { "id": 2, "name": "Document Editing", .. },
    ..
]

レスポンス コード

200 成功。テスト スイートがレスポンスの一部として返されます
400 無効または不明なプロジェクト ID です
403 プロジェクトにアクセスできません

add_suite

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

POST index.php?/api/v2/add_suite/:project_id
:project_id テスト スイートを追加するプロジェクトの ID

リクエスト フィールド

以下の POST フィールドがサポートされています。

名前 タイプ 説明
name string テスト スイートの名前 (必須)
description string テスト スイートの説明

リクエストの例

新しい空のテスト スイートを作成する方法を示す次の例も参照してください。

{
    "name": "This is a new test suite",
    "description": "Use the description to add additional context details"
}

テスト スイートを追加したら、セクションおよびテスト ケースを追加できます。

レスポンスの内容

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

レスポンス コード

200 成功。テスト スイートが作成され、レスポンスの一部として返されます
400 無効または不明なプロジェクト ID です
403 テスト スイートを追加する権限、またはプロジェクトへのアクセス権がありません

update_suite

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

POST index.php?/api/v2/update_suite/:suite_id
:suite_id テスト スイートの ID

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

レスポンスの内容

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

レスポンス コード

200 成功。テスト スイートが更新され、レスポンスの一部として返されます
400 無効または不明なテスト スイート ID です
403 テスト スイートを変更する権限、またはプロジェクトへのアクセス権がありません

delete_suite

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

POST index.php?/api/v2/delete_suite/:suite_id
:suite_id テスト スイートの ID

Soft パラメーター

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

soft=1 を設定すると、エンティティは実際には削除されません。

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

注意：テスト スイートの削除を元に戻すことはできず、すべてのアクティブな テスト ラン およびテスト結果、つまりまだクローズされていない (アーカイブされていない) テスト ラン およびテスト結果も削除されます。

レスポンス コード

200 成功。テスト スイートとすべてのアクティブな テスト ラン およびテスト結果が削除されました。
400 無効または不明なテスト スイート ID です
403 テスト スイートを削除する権限、またはプロジェクトへのアクセス権がありません