ステータスに関する情報を取得するには、次の API メソッドを使用します。
get_case_statuses
TestRail 7.3 以降が必要です。
利用可能なテスト ケース ステータスのリストを返します。
GET index.php?/api/v2/get_case_statuses
レスポンスの内容
返されたレスポンスには、すべてのテスト ケース ステータスが次の形式で含まれています。
[
{
"case_status_id": 1,
"name": "Approved",
"abbreviation": null,
"is_default": false,
"is_approved": true
},
{
"case_status_id": 2,
"name": "Draft",
"abbreviation": null,
"is_default": true,
"is_approved": false
}
]
レスポンスには次のフィールドが含まれます。
| 名前 | タイプ | 説明 |
|---|---|---|
| offset | integer | 手順の履歴のカウントを開始する位置 |
| limit | integer | 返されるレコードの最大数 |
| size | integer | 返されるレコードの数 |
| links | object | 次および前の値セットへの URI を含むオブジェクト (存在する場合) |
| case_statuses | object | ケースのステータス情報の配列 |
case_status fields
| 名前 | タイプ | 説明 |
|---|---|---|
| case_status_id | integer | ステータスの一意の ID |
| name | string | ステータスのシステム名 |
| abbreviation | string | ステータスの代替ラベル |
| is_default | boolean | ステータスがテスト ケースのデフォルト ステータスである場合は true |
| is_approved | boolean | ステータスが承認済みステータスである場合は true |
レスポンス コード
| ステータス コード | 説明 |
|---|---|
| 200 | 成功。利用可能なケース ステータスがレスポンスの一部として返されます |
get_statuses
利用可能なテスト ステータスのリストを返します。
GET index.php?/api/v2/get_statuses
レスポンスの内容
返されたレスポンスには、すべてのシステム ステータスとカスタム ステータスが次の形式で含まれています。
[
{
"color_bright": 12709313,
"color_dark": 6667107,
"color_medium": 9820525,
"id": 1,
"is_final": true,
"is_system": true,
"is_untested": false,
"label": "Passed",
"name": "passed"
},
{
"color_bright": 16631751,
"color_dark": 14250867,
"color_medium": 15829135,
"id": 5,
"is_final": true,
"is_system": true,
"is_untested": false,
"label": "Failed",
"name": "failed"
},
{
"color_bright": 13684944,
"color_dark": 0,
"color_medium": 10526880,
"id": 6,
"is_final": false,
"is_system": false,
"is_untested": false,
"label": "Custom",
"name": "custom_status1"
}
]
各ステータスには、一意の ID、名前 (システム名)、およびラベル (表示名) があります。色関連フィールドは、ステータスに使用されるさまざまな色を RGB 色として指定します。デフォルトでは以下のシステム ステータスが利用可能です。TestRail の [管理] > [カスタマイズ] で、カスタム ステータスを追加できます。
| ID | 名前 |
|---|---|
| 1 | Passed |
| 2 | Blocked |
| 3 | Untested |
| 4 | Retest |
| 5 | Failed |
レスポンス コード
| ステータス コード | 説明 |
|---|---|
| 200 | 成功。利用可能なステータスがレスポンスの一部として返されます |