ラベル

ラベルに関する情報を取得するには、次の API メソッドを使用します。

get_label

既存のラベルを返します。

GET index.php?/api/v2/get_label/{label_id}

パラメーター

名前	Type	必須	説明
label_id	integer	true	ラベルの ID。

レスポンスの内容

レスポンスの例

{ 
 "id": 1,
 "name": "Release 2.0",
 "created_by":"user_id",
 "created_on": unique timestamp,
}

レスポンス コード

ステータス コード	説明
200	成功。ラベルがレスポンスの一部として返されます
400	無効なラベル
403	プロジェクトにアクセス不可
429	TestRail Cloud のみ—リクエストが多すぎます (API レート制限を参照)

get_labels

既存のラベルのリストを返します。

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

パラメーター

名前	Type	必須	説明
project_id	integer	true	プロジェクトの ID。
offset	integer	false	テスト ケースのカウントを開始する位置 (オフセット)
limit	integer	false	レスポンスが返すべきラベルの数。

レスポンスの内容

レスポンスの例

{
    "offset": 0,
    "limit": 250,
    "size": 250,
    "_links": {
        "next": "/api/v2/get_labels/1&limit=250&offset=250",
        "prev": null
    },
    "labels": [
        {
            "id": 1,
            "title": "label1",
            "created_by":"2",
            "created_on": "timestamp",
        },
        {
            "id": 2,
            "title": "label2",
            "created_by":"2",
            "created_on": "timestamp",
        }
    ]
}

レスポンス コード

ステータス コード	説明
200	成功。ラベルがレスポンスの一部として返されます
400	無効なラベル
403	プロジェクトにアクセス不可
429	TestRail Cloud のみ—リクエストが多すぎます (API レート制限を参照)

update_label

既存のラベルを更新します。

POST index.php?/api/v2/update_label/{label_id}

パラメーター

名前	Type	必須	説明
project_id	integer	true	ラベルを更新するプロジェクトの ID。
title	string	true	ラベルのタイトル。最大 20 文字まで使用できます。

レスポンスの内容

レスポンスの例

{ 
  "id": 1,
  "title": "Release 2.0",
}

レスポンス コード

ステータス コード	説明
200	成功。ラベルがレスポンスの一部として返されます
400	無効または不明なテスト ケース
403	プロジェクトにアクセス不可
429	TestRail Cloud のみ—リクエストが多すぎます (API レート制限を参照)