API: セクション

get_section

既存のセクションを返します。

GET index.php?/api/v2/get_section/:section_id

レスポンスの内容

典型的なレスポンスについては、下記を参照してください。

{
    "depth": 0,
    "description": null,
    "display_order": 1,
    "id": 1,
    "name": "Prerequisites",
    "parent_id": null,
    "suite_id": 1
}

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

depth、display_order、および parent フィールドは、テスト スイート内のセクションの階層を決定します。depth フィールドは、ルート レベルのセクションではすべて 0 であり、子セクションではすべて 0 より大きい値です。したがって、depth フィールドはセクション階層のレベルに似ています。get_sections の例も参照してください。

レスポンス コード

get_sections

プロジェクトとテスト スイートのセクションのリストを返します。

GET index.php?/api/v2/get_sections/:project_id&suite_id=:suite_id

リクエスト フィルター

以下のフィルターを適用できます。

レスポンスの内容

典型的なレスポンスについては、下記を参照してください。

[
    {
        "depth": 0,
        "display_order": 1,
        "id": 1,
        "name": "Prerequisites",
        "parent_id": null,
        "suite_id": 1
    },
    {
        "depth": 0,
        "display_order": 2,
        "id": 2,
        "name": "Documentation & Help",
        "parent_id": null,
        "suite_id": 1
    },
    {
        "depth": 1, // A child section
        "display_order": 3,
        "id": 3,
        "name": "Licensing & Terms",
        "parent_id": 2, // Points to the parent section
        "suite_id": 1
    },
    ..
]

新しいレスポンスの内容

典型的なレスポンスについては、下記を参照してください。

{
    "offset": 0,
    "limit": 250,
    "size": 23,
    "_links": {
        "next": null,
        "prev": null,
    },
    "sections": [
        {
            "depth": 0,
            "display_order": 1,
            "id": 1,
            "name": "Prerequisites",
            "parent_id": null,
            "suite_id": 1
        },
        {
            "depth": 0,
            "display_order": 2,
            "id": 2,
            "name": "Documentation & Help",
            "parent_id": null,
            "suite_id": 1
        },
        {
            "depth": 1, // A child section
            "display_order": 3,
            "id": 3,
            "name": "Licensing & Terms",
            "parent_id": 2, // Points to the parent section
            "suite_id": 1
        },
      ..
    ]
}

含まれるフィールドの詳細については get_section も参照してください。

レスポンス コード

add_section

新規セクションを作成します。

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

リクエスト フィールド

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

リクエストの例

空のセクション (以前に作成したセクションを親として) を作成する方法を示す次の例も参照してください。

{
    "suite_id": 5,
    "name": "This is a new section",
    "parent_id": 10
}

セクションを追加したら、テスト ケース を追加できます。

レスポンスの内容

レスポンス コード

move_section

別のスイートまたはセクションにセクションを移動します (TestRail 6.5.2 以降が必要)。

POST index.php?/api/v2/move_section/:section_id

リクエスト フィールド

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

レスポンス コード

update_section

既存のセクションを更新します (部分的な更新がサポートされています。つまり、特定のフィールドのみを送信して更新できます)。

POST index.php?/api/v2/update_section/:section_id

リクエスト フィールド

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

リクエストの例

既存のセクションの名前を更新する方法を示す次の例も参照してください。

{
    "name": "A better section name"
}

レスポンスの内容

レスポンス コード

delete_section

既存のセクションを削除します。

POST index.php?/api/v2/delete_section/:section_id

Soft パラメーター

soft=1 の場合、影響を受けるテスト、テスト ケースなどの数に関するデータを返します。

soft=1 を設定すると、エンティティは実際には削除されません。

レスポンス コード