API: 設定

設定に関する情報を取得したり、設定を作成または変更するには、次の API メソッドを使用します。

get_configs

利用可能な設定のリストを設定グループ別に返します。

GET index.php?/api/v2/get_configs/:project_id

レスポンスの内容

レスポンスには設定グループの配列が含まれ、各グループに設定のリストが含まれます。典型的なレスポンスについては、下記を参照してください。

[
    {
        "configs": [
            {
                "group_id": 1,
                "id": 1,
                "name": "Chrome"
            },
            {
                "group_id": 1,
                "id": 2,
                "name": "Firefox"
            },
            {
                "group_id": 1,
                "id": 3,
                "name": "Internet Explorer"
            }
        ],
        "id": 1,
        "name": "Browsers",
        "project_id": 1
    },
    {
        "configs": [
            {
                "group_id": 2,
                "id": 6,
                "name": "Ubuntu 12"
            },
            {
                "group_id": 2,
                "id": 4,
                "name": "Windows 7"
            },
            {
                "group_id": 2,
                "id": 5,
                "name": "Windows 8"
            }
        ],
        "id": 2,
        "name": "Operating Systems",
        "project_id": 1
    }
]

レスポンスの例には 2 つの設定グループ (Browsers と Operating Systems) が含まれており、それぞれに 3 つのサンプル設定が含まれています。

設定の使い方の例については add_plan_entry および add_plan も参照してください。

レスポンス コード

add_config_group

新しい設定グループを作成します (TestRail 5.2 以降が必要です)。

POST index.php?/api/v2/add_config_group/:project_id

リクエスト フィールド

以下の POST フィールドがサポートされています。

リクエストの例

新しい設定グループを作成する方法を示す次の例も参照してください。

{
    "name": "Browsers"
}

レスポンス コード

add_config

新しい設定を作成します (TestRail 5.2 以降が必要です)。

POST index.php?/api/v2/add_config/:config_group_id

リクエスト フィールド

以下の POST フィールドがサポートされています。

リクエストの例

新しい設定を作成する方法を示す次の例も参照してください。

{
    "name": "Chrome"
}

レスポンス コード

update_config_group

既存の設定グループを更新します (TestRail 5.2 以降が必要です)。

POST index.php?/api/v2/update_config_group/:config_group_id

リクエスト フィールド

以下の POST フィールドがサポートされています。

リクエストの例

既存の設定グループを更新する方法を示す次の例も参照してください。

{
    "name": "Operating Systems"
}

レスポンス コード

update_config

既存の設定を更新します (TestRail 5.2 以降が必要です)。

POST index.php?/api/v2/update_config/:config_id

リクエスト フィールド

以下の POST フィールドがサポートされています。

リクエストの例

既存の設定を更新する方法を示す次の例も参照してください。

{
    "name": "Firefox"
}

レスポンス コード

delete_config_group

既存の設定グループとその設定を削除します (TestRail 5.2 以降が必要です)。

POST index.php?/api/v2/delete_config_group/:config_group_id

レスポンス コード

delete_config

既存の設定を削除します (TestRail 5.2 以降が必要です)。

POST index.php?/api/v2/delete_config/:config_id

レスポンス コード