API:添付ファイル

API:添付ファイル

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

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

Content-Type multipart/form-data

添付ファイルは、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
:case_id 添付ファイルを追加するテスト ケースの ID

レスポンスの内容

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

{
    "attachment_id": 443
}

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

名前 タイプ 説明
attachment_id int TestRail にアップロードされた添付ファイルの ID

レスポンス コード

200 成功。添付ファイルのIDがレスポンスの一部として返されます
400 POSTリクエストが正しくフォーマットされていないか、ケース IDが無効です
403 プロジェクトへのアクセス権がないか、権限が不十分です

add_attachment_to_plan

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

TestRail 6.3 以降が必要です。

POST index.php?/api/v2/add_attachment_to_plan/:plan_id
:plan_id 添付ファイルを追加するテスト計画の ID

レスポンスの内容

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

{
    "attachment_id": 443
}

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

名前 タイプ 説明
attachment_id int TestRail にアップロードされた添付ファイルの ID

レスポンス コード

200 成功。添付ファイルのIDがレスポンスの一部として返されます
400 POSTリクエストが正しくフォーマットされていないか、計画 IDが無効です
403 プロジェクトへのアクセス権がないか、権限が不十分です

add_attachment_to_plan_entry

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

TestRail 6.3 以降が必要です。

POST index.php?/api/v2/add_attachment_to_plan_entry/:plan_id/:entry_id
:plan_id エントリを含むテスト計画の ID
:entry_id 添付ファイルを追加するテスト計画のエントリ ID

レスポンスの内容

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

{
    "attachment_id": 443
}

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

名前 タイプ 説明
attachment_id int TestRail にアップロードされた添付ファイルの IDT

レスポンス コード

200 成功。添付ファイルのIDがレスポンスの一部として返されます
400 POSTリクエストが正しくフォーマットされていないか、パラメータの ID が無効です
403 プロジェクトへのアクセス権がないか、権限が不十分です

add_attachment_to_result

注意: Add_attachment_to_result エンドポイントを利用するには、[サイト設定] でテスト結果の編集機能を有効にする必要があります。

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

TestRail 5.7 以降が必要です。

POST index.php?/api/v2/add_attachment_to_result/:result_id
:result_id 添付ファイルを追加するテスト結果の ID

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

レスポンスの内容

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

{
    "attachment_id": 443
}

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

名前 タイプ 説明
attachment_id int TestRail にアップロードされた添付ファイルの ID

レスポンス コード

200 成功。添付ファイルのIDがレスポンスの一部として返されます
400 POSTリクエストが正しくフォーマットされていないか、結果 IDが無効です
403 プロジェクトにアクセスできません

add_attachment_to_run

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

TestRail 6.3 以降が必要です。

POST index.php?/api/v2/add_attachment_to_run/:run_id
:run_id 添付ファイルを追加するテストランのID

レスポンスの内容

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

{
    "attachment_id": 443
}

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

名前 タイプ 説明
attachment_id int TestRail にアップロードされた添付ファイルの ID

レスポンス コード

200 成功。添付ファイルのIDがレスポンスの一部として返されます
400 POSTリクエストが正しくフォーマットされていないか、パラメータの ID が無効です
403 プロジェクトへのアクセス権がないか、権限が不十分です

get_attachments_for_case

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

TestRail 5.7 以降が必要です。

GET index.php?/api/v2/get_attachments_for_case/:case_id
:case_id 添付ファイルを取得するテスト ケースの ID

注意: 2021 年 2 月 26日から、一括 GET API エンドポイントが返すデータの構造が変更されます。これらの一括エンドポイントは、すべてのエントリの配列ではなく、追加のページ分割フィールドを持つオブジェクトと、250 エンティティまでの配列を返します。新しいレスポンス構造を確認し、必要に応じたコードの変更をテストするには、API リクエストに次のヘッダーと値を含めます: x-api-ident: beta

新しいレスポンスの内容

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

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

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

名前 タイプ 説明
id int 添付ファイルの一意の ID
name string 添付ファイルの名前
Size int 添付ファイルのサイズ (単位: バイト)
created_on timestamp 添付ファイルがアップロードされた日時
project_id int 添付ファイルがアップロードされたプロジェクトの ID
case_id int 添付ファイルが所属するケースの ID
user_id int 添付ファイルをアップロードしたユーザーの ID
result_id int 添付ファイルが所属するテスト結果の ID

リクエスト フィルター

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

名前 タイプ 説明
:limit integer レスポンスが返す添付ファイルの数 (デフォルトのレスポンスのサイズは 250) (TestRail 6.7 以降が必要)
:offset integer 添付ファイルのカウントを開始する位置 (オフセット) (TestRail 6.7 以降が必要)

レスポンス コード

200 成功。添付ファイルの詳細情報の配列がレスポンスとして返されます
400 無効なテストケース ID です
403 プロジェクトにアクセスできません

get_attachments_for_plan

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

TestRail 6.3 以降が必要です。

GET index.php?/api/v2/get_attachments_for_plan/:plan_id
:plan_id 添付ファイルのリストを取得するテスト計画の ID

注意: 2021 年 2 月 26日から、一括 GET API エンドポイントが返すデータの構造が変更されます。これらの一括エンドポイントは、すべてのエントリの配列ではなく、追加のページ分割フィールドを持つオブジェクトと、250 エンティティまでの配列を返します。新しいレスポンス構造を確認し、必要に応じたコードの変更をテストするには、API リクエストに次のヘッダーと値を含めます: x-api-ident: beta

新しいレスポンスの内容

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

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

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

名前 タイプ 説明
id int 添付ファイルの一意の ID
name string 添付ファイルの名前
size int 添付ファイルのサイズ (単位: バイト)
created_on timestamp 添付ファイルがアップロードされた日時
project_id int 添付ファイルがアップロードされたプロジェクトの ID
case_id int 添付ファイルが所属するケースの ID
user_id int 添付ファイルをアップロードしたユーザーの ID
entity_attachments_id int 添付ファイル レコードの ID (添付ファイル自体の ID ではない)
icon_name string TestRail UI で使用されるアイコンの名前
result_id int 添付ファイルが所属するテスト結果の ID

リクエスト フィルター

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

名前 タイプ 説明
:limit integer レスポンスが返す添付ファイルの数 (デフォルトのレスポンスのサイズは 250) (TestRail 6.7 以降が必要)
:offset integer 添付ファイルのカウントを開始する位置 (オフセット) (TestRail 6.7 以降が必要)

レスポンス コード

200 成功。添付ファイルのリストがレスポンスの一部として返されます
400 Invalid test ID
403 プロジェクトへのアクセス権がないか、権限が不十分です

get_attachments_for_plan_entry

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

TestRail 6.3 以降が必要です。

GET index.php?/api/v2/get_attachments_for_plan_entry/:plan_id/:entry_id
:plan_id エントリを含むテスト計画の ID
:entry_id 添付ファイルのリストを取得するテスト計画のエントリ ID

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

レスポンス コード

200 成功。添付ファイルのリストがレスポンスの一部として返されます
400 Invalid test ID
403 プロジェクトへのアクセス権がないか、権限が不十分です

get_attachments_for_run

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

TestRail 6.3 以降が必要です。

GET index.php?/api/v2/get_attachments_for_run/:run_id
:run_id 添付ファイルのリストを取得するテストランの ID

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

注意: 2021 年 2 月 26日から、一括 GET API エンドポイントが返すデータの構造が変更されます。これらの一括エンドポイントは、すべてのエントリの配列ではなく、追加のページ分割フィールドを持つオブジェクトと、250 エンティティまでの配列を返します。新しいレスポンス構造を確認し、必要に応じたコードの変更をテストするには、API リクエストに次のヘッダーと値を含めます: x-api-ident: beta

リクエスト フィルター

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

名前 タイプ 説明
:limit integer レスポンスが返す添付ファイルの数 (デフォルトのレスポンスのサイズは 250) (TestRail 6.7 以降が必要)
:offset integer 添付ファイルのカウントを開始する位置 (オフセット) (TestRail 6.7 以降が必要)

レスポンス コード

200 成功。添付ファイルのリストがレスポンスの一部として返されます
400 Invalid test ID
403 プロジェクトにアクセスできません

get_attachments_for_test

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

TestRail 5.7 以降が必要です。

GET index.php?/api/v2/get_attachments_for_test/:test_id
:test_id 添付ファイルを取得するテストの ID

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

レスポンス コード

200 成功。添付ファイルのIDがレスポンスの一部として返されます
400 無効なテスト ID です
403 プロジェクトへのアクセス権がないか、権限が不十分です

get_attachment

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

TestRail 5.7 以降が必要です。

GET index.php?/api/v2/get_attachment/:attachment_id
:attachment_id 取得する添付ファイルの ID

レスポンス コード

200 成功。添付ファイルがレスポンスのbodyとして返されます
400 無効な添付ファイル ID です
403 プロジェクトへのアクセス権がないか、権限が不十分です

delete_attachment

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

TestRail 5.7 以降が必要です。

POST index.php?/api/v2/delete_attachment/:attachment_id
:attachment_id 削除する添付ファイルの ID

レスポンスの内容

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

レスポンス コード

200 成功。添付ファイルが削除されました
400 無効な添付ファイル ID です
403 プロジェクトへのアクセス権がないか、権限が不十分です