添付ファイル

添付ファイルをアップロード、取得、削除するには、次の API メソッドを使用します。  

TestRail API 経由で POST リクエストを使用して添付ファイルをアップロードする場合、次のヘッダーが必要です。

Content-Type: multipart/form-data

添付ファイルは、form-dataとしてリクエストのbodyで指定しなければなりません。添付ファイルの送信例については、 API へのアクセス のドキュメントまたは TestRailのバインディングを参照してください。

add_attachment_to_case

テスト計画に添付ファイルを追加します。最大許容アップロード サイズは 256MB に設定されています。

POST index.php?/api/v2/add_attachment_to_case/{case_id}

パラメーター

{
    "attachment_id": 443
}

POST index.php?/api/v2/add_attachment_to_plan/{plan_id}

{
    "attachment_id": 443
}

POST index.php?/api/v2/add_attachment_to_plan_entry/{plan_id}/{entry_id}

{
    "attachment_id": 443
}

POST index.php?/api/v2/add_attachment_to_result/{result_id}

{
    "attachment_id": 443
}

POST index.php?/api/v2/add_attachment_to_run/{run_id}

{
    "attachment_id": 443
}

GET index.php?/api/v2/get_attachments_for_case/{case_id}&limit={limit}&offset={offset}

{
    "offset": 0,
    "limit": 250,
    "size": 0,
    "_link": {
        "next": null,
        "prev": null,
    },
    "attachments": [
        {
            "id": 1773,
            "name": "image.jpg",
            "size": 21995,
            "created_on": 1585560521,
            "project_id": 33,
            "case_id": 57333,
            "user_id": 1,
            "result_id": null
        }
    ]
}

{
    "offset": 0,
    "limit": 250,
    "size": 4,
    "_links": {
        "next": null,
        "prev": null
    },
    "attachments": [
        {
            "client_id": 614308,
            "project_id": 2,
            "entity_type": "case",
            "id": "2ec27be4-812f-4806-9a5d-d39130d1691a",
            "created_on": 1631722975,
            "data_id": "63c82867-526d-43be-b1a5-9ddfcf581cf5",
            "entity_id": "3",
            "filename": "msdia80.dll",
            "filetype": "dll",
            "legacy_id": 0,
            "name": "msdia80.dll",
            "size": 904704,
            "user_id": 1,
            "is_image": false,
            "icon": "other"
        }
    ]
}

GET index.php?/api/v2/get_attachments_for_plan/{plan_id}&limit={limit}&offset={offset}

パラメーター

リクエスト フィルター

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

[
    {
        "id": 1900,
        "name": "TR-2104.gif",
        "size": 3838070,
        "created_on": 1602178189,
        "project_id": 15,
        "case_id": null,
        "user_id": 1,
        "entity_attachments_id": 360,
        "icon_name": "Gif Image",
        "result_id": null
    }
]

get_attachments_for_plan_entry

テスト計画エントリに含まれる添付ファイルのリストを返します。

GET index.php?/api/v2/get_attachments_for_plan_entry/{plan_id}/{entry_id}

パラメーター

このメソッドは get_attachments_for_plan と同じレスポンス フォーマットを使用します。

レスポンス コード

get_attachments_for_run

GET index.php?/api/v2/get_attachments_for_run/{run_id}?limit={limit}&offset={offset}

パラメーター

このメソッドは get_attachments_for_plan と同じレスポンス フォーマットを使用します。

リクエスト フィルター

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

レスポンス コード

get_attachments_for_test

1 つのテスト結果に対する添付ファイルのリストを返します。

GET index.php?/api/v2/get_attachments_for_test/{test_id}

パラメーター

このメソッドは get_attachments_for_case と同じレスポンス フォーマットを使用します。

レスポンス コード

get_attachment

GET index.php?/api/v2/get_attachment/{attachment_id}

レスポンス コード

delete_attachment

指定された attachment_id の添付ファイルを削除します。

POST index.php?/api/v2/delete_attachment/{attachment_id}

パラメーター

レスポンスの内容

delete_attachment POST が成功すると、レスポンス コード 200 で本体が空のレスポンスが返されます。

レスポンス コード