ページを選択

ロール

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

get_roles

利用可能なロールのリストを返します。

TestRail 7.3 以降が必要です。

GET index.php?/api/v2/get_roles

レスポンスの内容 (TestRail Professional)

典型的なレスポンスについては、次のサンプルを参照してください。

{
    "offset": 0,
    "limit": 250,
    "size": 2,
    "_links": {
        "next": null,
        "prev": null
    },
    "roles": [
        {
            "id": 3,
            "name": "Tester",
            "is_default": false
        },
        {
            "id": 1,
            "name": "Lead",
            "is_default": true
        }
    ]
}

レスポンスの内容 (TestRail Enterprise)

典型的なレスポンスについては、次のサンプルを参照してください。

{
    "offset": 0,
    "limit": 250,
    "size": 2,
    "_links": {
        "next": null,
        "prev": null
    },
    "roles": [
        {
            "id": 3,
            "name": "Tester",
            "is_default": false,
            "is_project_admin": false
        },
        {
            "id": 1,
            "name": "Lead",
            "is_default": true,
            "is_project_admin": false
        }
    ]
}

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

名前 タイプ 説明
id integer ロールの ID
name string ロールの名前
is_default boolean デフォルトのユーザー ロールの場合は true
is_project_admin boolean ロールにプロジェクト レベルの管理者権限がある場合は true(TestRail Enterprise が必要です)