テスト スイート

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

GET index.php?/api/v2/get_suite/{suite_id}

パラメーター

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

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

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

レスポンス コード

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

パラメーター

リクエスト ボディ

POST リクエスト ボディでは以下のフィールドがサポートされています。

リクエストの例

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

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

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

レスポンスの内容

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

レスポンス コード

update_suite

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

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

パラメーター

レスポンスの内容

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

レスポンス コード

delete_suite

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

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

パラメーター

Soft パラメーター

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

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

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

レスポンス コード