共有テスト手順

共有テスト手順に関する詳細をリクエストするには、次の API メソッドを使用します。 

共有テスト手順および関連エンドポイントは TestRail 7.0 以降で利用可能です。

get_shared_step

既存の共有テスト手順のセットを返します。

GET index.php?/api/v2/get_shared_step/{shared_step_id}

パラメーター

{
    "id": 1,
    "title": "Default Login",
    "project_id": 2,
    "created_by": 1,
    "created_on": 1612555977,
    "updated_by": 1,
    "updated_on": 1612555977,
    "custom_steps_separated": [
        {
            "content": "Navigate to https:\\/\\/localhost\\/some_app",
            "additional_info": null,
            "expected": "Login screen loads",
            "refs": "TR-123"
        },
        {
            "content": "Enter Valid Credentials",
            "additional_info": null,
            "expected": "Logged in and redirected to dashboard",
            "refs": null
        }
    ],
    "case_ids": [
        25
    ]
}

レスポンス コード

get_shared_step_history

GET index.php?/api/v2/get_shared_step_history/{shared_step_id}

パラメーター

{
    "offset": 0,
    "limit": 250,
    "size": 2,
    "_links": {
        "next": null,
        "prev": null
    },
    "step_history": [
        {
            "id": "1",
            "timestamp": 1389968184,
            "user_id": "4",
            "custom_steps_separated": [
                {
                    "content": "Step 1",
                    "additional_info": "Step 1 Additional Information",
                    "expected": "Expected Result 1",
                    "refs": "ABC-1, ABC-2"
                }
            ],
            "title": "Shared Steps 1"
        }
    ]
}

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

リクエスト ボディ

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

# All shared steps for project with ID 1 created by user with ID 1 or 2
GET index.php?/api/v2/get_shared_steps/1&created_by=1,2

レスポンスの内容

レスポンスには共有テスト手順の配列が含まれます。リスト内の各エントリの形式は、get_shared_step と同じです。

{
    "offset": 0,
    "limit": 250,
    "size": 250,
    "_links": {
        "next": "/api/v2/get_shared_steps/1&limit=250&offset=250",
        "prev": null
    },
    "shared_steps": [
        {
            "id": 1,
            "title": "Shared Step 1",
        },
        {
            "id": 2,
            "title": "Shared Step 2",
        }
    ]
}

レスポンス コード

add_shared_step

新しい共有テスト手順のセットを作成します。プロジェクトにテスト ケースを追加する権限が必要です。

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

パラメーター

リクエスト ボディ

custom_steps_separated fields

配列内の個々の JSON オブジェクトには、以下のフィールドが少なくとも 1 つ含まれている必要があります。

リクエストの例

新しい共有テスト手順のセットを作成する方法を示す次の例も参照してください。

{
    "title": "First Step",
    "custom_steps_separated": [
        {
            "content": "Open home page",
            "additional_info": "Must be a new browser session",
            "expected": "Login page loads",
            "refs": "RF-1"
        },
        {
            "content": "Log In",
        }
    ]
}

レスポンスの内容

成功した場合、このメソッドは get_shared_step と同じレスポンス形式を使用して新しい共有手順を返します。

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

update_shared_step

既存の共有テスト手順のセットを更新します (部分的な更新がサポートされています。つまり、特定のフィールドのみを送信して更新できます)。プロジェクトのテスト ケースを編集する権限が必要です。

POST index.php?/api/v2/update_shared_step/{shared_update_id}

パラメーター

リクエスト ボディ

メソッドは add_shared_step と同じフィールドをサポートしています。custom_steps_separated フィールドをサブミットすると、すべての既存の手順が置き換えられます。

レスポンスの内容

成功した場合、このメソッドは get_shared_step と同じレスポンス形式を使用して更新された共有手順を返します。

{
    "id": 1,
    "title": "Default Login",
    "project_id": 2,
    "created_by": 1,
    "created_on": 1612555977,
    "updated_by": 1,
    "updated_on": 1612555977,
    "custom_steps_separated": [
        {
            "content": "Navigate to https:\\/\\/localhost\\/some_app",
            "additional_info": null,
            "expected": "Login screen loads",
            "refs": "TR-123"
        },
        {
            "content": "Enter Valid Credentials",
            "additional_info": null,
            "expected": "Logged in and redirected to dashboard",
            "refs": null
        }
    ],
    "case_ids": [
        25
    ]
}

レスポンス コード

delete_shared_step

POST index.php?/api/v2/delete_shared_step/{shared_update_id}

パラメーター

リクエスト ボディ

{
   "keep_in_cases":0
 }

レスポンスの内容

成功した場合、このメソッドはステータス コード 200 を返し、他のデータは返しません。

レスポンス コード