API：添付ファイル

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

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

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

add_attachment_to_case

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

TestRail 6.5.2 以降が必要です。

POST index.php?/api/v2/add_attachment_to_case/:case_id

レスポンスの内容

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

{
    "attachment_id": 443
}

レスポンスには次のシステム項目が常に含まれています。

レスポンス コード

add_attachment_to_plan

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

TestRail 6.3 以降が必要です。

POST index.php?/api/v2/add_attachment_to_plan/:plan_id

レスポンスの内容

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

{
    "attachment_id": 443
}

レスポンスには次のシステム項目が常に含まれています。

レスポンス コード

add_attachment_to_plan_entry

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

TestRail 6.3 以降が必要です。

POST index.php?/api/v2/add_attachment_to_plan_entry/:plan_id/:entry_id

レスポンスの内容

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

{
    "attachment_id": 443
}

レスポンスには次のシステム項目が常に含まれています。

レスポンス コード

add_attachment_to_result

指定された結果 ID を持つ結果に添付ファイルを追加します。最大許容アップロード サイズは 256MB に設定されています。

TestRail 5.7 以降が必要です。

POST index.php?/api/v2/add_attachment_to_result/:result_id

:result_id を取得する方法の詳細については、結果 API のドキュメントを参照してください。

レスポンスの内容

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

{
    "attachment_id": 443
}

レスポンスには次のシステム項目が常に含まれています。

レスポンス コード

add_attachment_to_run

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

TestRail 6.3 以降が必要です。

POST index.php?/api/v2/add_attachment_to_run/:run_id

レスポンスの内容

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

{
    "attachment_id": 443
}

レスポンスには次のシステム項目が常に含まれています。

レスポンス コード

get_attachments_for_case

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

TestRail 5.7 以降が必要です。

GET index.php?/api/v2/get_attachments_for_case/:case_id

新しいレスポンスの内容

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

{
    "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
        }
    ]
}

レスポンスには次のシステム項目が常に含まれています。

リクエスト フィルター

以下のフィルターが適用されます。

レスポンス コード

get_attachments_for_plan

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

TestRail 6.3 以降が必要です。

GET index.php?/api/v2/get_attachments_for_plan/:plan_id

新しいレスポンスの内容

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

[
    {
        "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

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

TestRail 6.3 以降が必要です。

GET index.php?/api/v2/get_attachments_for_plan_entry/:plan_id/:entry_id

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

レスポンス コード

get_attachments_for_run

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

TestRail 6.3 以降が必要です。

GET index.php?/api/v2/get_attachments_for_run/:run_id

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

リクエスト フィルター

以下のフィルターが適用されます。

レスポンス コード

get_attachments_for_test

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

TestRail 5.7 以降が必要です。

GET index.php?/api/v2/get_attachments_for_test/:test_id

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

レスポンス コード

get_attachment

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

TestRail 5.7 以降が必要です。

GET index.php?/api/v2/get_attachment/:attachment_id

レスポンス コード

delete_attachment

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

TestRail 5.7 以降が必要です。

POST index.php?/api/v2/delete_attachment/:attachment_id

レスポンスの内容

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

レスポンス コード