テスト計画の設定に関する情報を取得したり、設定を作成または変更するには、次の API メソッドを使用します。
get_configs
利用可能な設定のリストを設定グループ別に返します。
GET index.php?/api/v2/get_configs/{project_id}
パラメーター
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| project_id | integer | true | プロジェクトの ID |
レスポンスの内容
レスポンスには設定グループの配列が含まれ、各グループに設定のリストが含まれます。典型的なレスポンスについては、下記を参照してください。
[
{
"id": 1,
"name": "Browsers",
"project_id": 1,
"configs": [
{
"id": 3,
"name": "Chrome",
"group_id": 1
},
{
"id": 4,
"name": "Firefox ",
"group_id": 1
},
{
"id": 1,
"name": "IE 10",
"group_id": 1
},
{
"id": 2,
"name": "IE 11",
"group_id": 1
},
{
"id": 5,
"name": "Safari",
"group_id": 1
}
]
}
]
レスポンスの例は複数のブラウザー設定グループを示しています。
| ID | 設定 |
|---|---|
| 1 | Internet Explorer 10 |
| 2 | Internet Explorer 11 |
| 3 | Chrome |
| 4 | Firefox |
| 5 | Safari |
設定の使い方の例については add_plan_entry および add_plan も参照してください。
レスポンス コード
| ステータス コード | 説明 |
|---|---|
| 200 | 成功。設定がレスポンスの一部として返されます |
| 400 | 無効または不明なテスト ケース |
| 403 | プロジェクトにアクセスできない |
| 429 | TestRail Cloud のみ – リクエストが多すぎます |
add_config_group
TestRail 5.2 以降が必要です。
新しい設定グループを作成します。
POST index.php?/api/v2/add_config_group/{project_id}
パラメーター
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| project_id | integer | true | 設定グループを追加するプロジェクトの ID |
リクエスト ボディ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | true | 設定グループの名前 |
リクエストの例
新しい設定グループを作成する方法を示す次の例も参照してください。
{
"name": "Browsers"
}
レスポンス コード
| ステータス コード | 説明 |
|---|---|
| 200 | 成功。設定グループが作成され、レスポンスの一部として返されます |
| 400 | 無効または不明なプロジェクト |
| 403 | 設定グループを追加する権限、またはプロジェクトにアクセスできない |
| 429 | TestRail Cloud のみ – リクエストが多すぎます |
add_config
TestRail 5.2 以降が必要です。
新しい設定を作成します。
POST index.php?/api/v2/add_config/{config_group_id}
パラメーター
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| config_group_id | integer | true | 設定を追加する設定グループの ID |
リクエスト ボディ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | true | 設定の名前 |
リクエストの例
新しい設定を作成する方法を示す次の例も参照してください。
{
"name": "Chrome"
}
レスポンス コード
| ステータス コード | 説明 |
|---|---|
| 200 | 成功。設定グループが作成され、レスポンスの一部として返されます |
| 400 | 無効または不明な設定グループです |
| 403 | 設定グループを追加する権限、またはプロジェクトにアクセスできない |
| 429 | TestRail Cloud のみ – リクエストが多すぎます |
update_config_group
TestRail 5.2 以降が必要です。
既存の設定グループを更新します。
POST index.php?/api/v2/update_config_group/{config_group_id}
パラメーター
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| config_group_id | integer | true | 設定グループの ID |
リクエスト ボディ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | false | 設定グループの名前 |
リクエストの例
既存の設定グループを更新する方法を示す次の例も参照してください。
{
"name": "Operating Systems"
}
レスポンス コード
| ステータス コード | 説明 |
|---|---|
| 200 | 成功。設定グループが更新され、レスポンスの一部として返されます |
| 400 | 無効または不明な設定グループです |
| 403 | 設定グループを変更する権限、またはプロジェクトにアクセスできない |
| 429 | TestRail Cloud のみ – リクエストが多すぎます |
update_config
TestRail 5.2 以降が必要です。
既存の設定を更新します。
POST index.php?/api/v2/update_config/{config_id}
パラメーター
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| config_id | integer | true | 設定の ID |
リクエスト ボディ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | false | 設定の名前 |
リクエストの例
既存の設定を更新する方法を示す次の例も参照してください。
{
"name": "Firefox"
}
レスポンス コード
| ステータス コード | 説明 |
|---|---|
| 200 | 成功。設定が更新され、レスポンスの一部として返されます |
| 400 | 無効または不明な設定の ID です |
| 403 | 設定を変更する権限、またはプロジェクトへのアクセス権がありません |
| 429 | TestRail Cloud のみ – リクエストが多すぎます |
delete_config_group
TestRail 5.2 以降が必要です。
削除した設定グループを元に戻すことはできず、グループ内のすべての設定も永久に削除されます。ただし、クローズ済みのテスト計画/テスト ランは影響を受けず、アクティブなテスト計画/テスト ランも更新されない限り影響を受けません。
既存の設定グループとその設定を削除します。
POST index.php?/api/v2/delete_config_group/{config_group_id}
パラメーター
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| config_group_id | integer | true | 設定グループの ID |
レスポンス コード
| ステータス コード | 説明 |
|---|---|
| 200 | 成功。設定グループとそのすべての構成が削除されました |
| 400 | 無効または不明な設定グループです |
| 403 | 設定グループを削除する権限、またはプロジェクトにアクセス権がありません |
| 429 | TestRail Cloud のみ – リクエストが多すぎます |
delete_config
TestRail 5.2 以降が必要です。
削除した設定グループを元に戻すことはできず、グループ内のすべての設定も永久に削除されます。ただし、クローズ済みのテスト計画/テスト ランは影響を受けず、アクティブなテスト計画/テスト ランも更新されない限り影響を受けません。
既存の設定を削除します。
POST index.php?/api/v2/delete_config/{config_id}
パラメーター
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| config_id | integer | true | 設定の ID |
レスポンス コード
| ステータス コード | 説明 |
|---|---|
| 200 | 成功。設定は削除されました |
| 400 | 無効または不明な設定です |
| 403 | 設定を削除する権限、またはプロジェクトへのアクセス権がありません |
| 429 | TestRail Cloud のみ – リクエストが多すぎます |