ページを選択

レポートおよびクロスプロジェクト レポート

API からアクセス可能な単一プロジェクトのレポートを取得して実行するには、以下のメソッドを使用します。

API エンドポイントを介してレポートにアクセスする前に、レポートを API からアクセス可能にする必要があります。 それには、新しいレポートを作成し、 [レポート作成: API 経由でオンデマンド] チェックボックスをオンにします。

いったんレポートを保存した後では、[レポート作成] 設定を変更できません。そのため、既存のスケジュール済みレポートを API からアクセスできるよう変更することはできません。

レポートを作成し、 [レポート作成: API 経由でオンデマンド] をオンにすると、他のレポートの隣にある [API テンプレート] セクション タブにレポートが表示されます。

[API テンプレート] セクションのレポートは、以下で説明する API エンドポイントを使用して取得と実行が可能です。
レポートは実行直後には利用できない場合があります。特に TestRail Server をご利用の場合、レポートが利用可能になるまでにかかる時間は異なる場合があります。

get_reports

プロジェクトの API から利用可能な単一プロジェクト レポートのリストを返します。

GET index.php?/api/v2/get_reports/{project_id}

パラメーター

名前 Type 必須 説明
project_id integer true API から利用可能なレポートのリストが必要なプロジェクトのID

レスポンスの内容

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

[
    {
        "id": 1,
        "name": "Activity Summary (Cases) %date%",
        "description": null,
        "notify_user": true,
        "notify_link": false,
        "notify_link_recipients": null,
        "notify_attachment": false,
        "notify_attachment_recipients": "person1@example.com\r\nperson2@example.com",
        "notify_attachment_html_format": false,
        "notify_attachment_pdf_format": false,
        "cases_groupby": "day",
        "changes_daterange": "5",
        "changes_daterange_from": null,
        "changes_daterange_to": null,
        "suites_include": "1",
        "suites_ids": null,
        "sections_include": "1",
        "sections_ids": null,
        "cases_columns": {
            "cases:id": 75,
            "cases:title": 0,
            "cases:created_by": 125,
            "cases:updated_by": 125
        },
        "cases_filters": null,
        "cases_limit": 1000,
        "content_hide_links": false,
        "cases_include_new": true,
        "cases_include_updated": true
    }
]

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

名前 Type 説明
id integer レポートの一意の ID
name string レポート名
description string レポートの説明
notify_user boolean レポートが実行されるたびに作成者に通知するかどうかを示します。
notify_link boolean レポートへのリンクを含む電子メールを送信するかどうかを示します。
notify_link_recipients string レポートを送信するユーザーのリストです。
notify_attachment boolean レポートを添付ファイルとして電子メールで送信するかどうかを示します。
notify_attachment_html_format boolean notify_attachment が true の場合、レポートを HTML 形式の電子メールで送信するかどうかを示します。
notify_attachment_pdf_format boolean notify_attachment が true の場合、レポートを PDF 形式の電子メールで送信するかどうかを示します。

レスポンス コード

ステータス コード 説明
200 成功。レポートはレスポンスの一部として返されます
400 無効または不明なプロジェクト
403 プロジェクトにアクセス不可
429 TestRail Cloud のみ—リクエストが多すぎます (API レート制限を参照)

run_report

TestRail 5.7 以降が必要です。

report_id パラメーターで指定されたレポートを実行し、HTML および PDF フォーマットのレポートにアクセスするための URL を返します。

GET index.php?/api/v2/run_report/{report_template_id}

レスポンスの内容

{
    "report_url": "https://docs.testrail.com/index.php?/reports/view/383",
    "report_html": "https://docs.testrail.com/index.php?/reports/get_html/383",
    "report_pdf": "https://docs.testrail.com/index.php?/reports/get_pdf/383"
}

レスポンス コード

ステータス コード 説明
200 成功。レポートはレスポンスの一部として返されます
400 無効なレポート テンプレート ID です
403 プロジェクトにアクセス不可
429 TestRail Cloud のみ—リクエストが多すぎます (API レート制限を参照)

get_cross_project_reports

API から利用でき、ユーザーがアクセス権を持つすべてのクロスプロジェクト レポートを返します。Enterprise ライセンスでのみ利用可能です。

GET index.php?/api/v2/get_cross_project_reports/

パラメーター

入力パラメーターはありません。

レスポンスの内容

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

[
    {
        "id": 1,
        "name": "Test Execution Projects Summary %date%",
        "description": null,
        "project_ids": [],
        "include_open_milestones": true,
        "include_completed_milestones": true,
        "include_open_runs_and_plans": true,
        "include_completed_runs_and_plans": true,
        "report_timeframe": "90 days",
        "included_statuses": "Passed, Blocked, Untested",
        "content_hide_links": false,
        "notify_user": true,
        "notify_link": false,
        "notify_link_recipients": null,
        "notify_attachment": false,
        "notify_attachment_recipients": "person1@example.com\r\nperson2@example.com",
        "notify_attachment_html_format": false,
        "notify_attachment_pdf_format": false
    },
    {
        "id": 2,
        "name": "Test Execution User Workload %date%",
        "description": null,
        "user_ids": [],
        "project_ids": [],
        "report_timeframe": "90 days",
        "include_open_runs_and_plans": true,
        "include_completed_runs_and_plans": true,
        "include_elapsed_test_time": true,
        "include_estimated_test_time": true,
        "sort_by": "alphabetical",
        "content_hide_links": false,
        "notify_user": true,
        "notify_link": false,
        "notify_link_recipients": null,
        "notify_attachment": false,
        "notify_attachment_recipients": "person1@example.com\r\nperson2@example.com",
        "notify_attachment_html_format": false,
        "notify_attachment_pdf_format": false
    }
]

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

名前 Type 説明
id integer レポートの一意の ID
name string レポート名
description string レポートの説明
project_ids list レポートに含まれるプロジェクト ID のリスト
user_ids list レポートに含まれるユーザー ID のリストユーザーの負荷レポートでのみ利用可能
include_elapsed_test_time boolean テスト経過時間を含むかどうかユーザーの負荷レポートでのみ利用可能
include_estimated_test_time boolean テスト見積り時間を含むかどうかユーザーの負荷レポートでのみ利用可能
sort_by string 選択されたソート オプションを含むユーザーの負荷レポートでのみ利用可能
include_open_milestones boolean オープン中のマイルストーンを含むかどうか
include_completed_milestones boolean 完了済みのマイルストーンを含むかどうか
include_open_runs_and_plans boolean オープン中のランおよび計画を含むかどうか
include_completed_runs_and_plans boolean 完了済みのランおよび計画を含むかどうか
report_timeframe date レポートの実行に選択された時間枠
included_statuses list レポートの実行対象として選択されたステータス
notify_user boolean レポートが実行されるたびに作成者に通知するかどうかを示します。
notify_link boolean レポートへのリンクを含む電子メールを送信するかどうかを示します。
notify_link_recipients string レポートを送信するユーザーのリストです。
notify_attachment boolean レポートを添付ファイルとして電子メールで送信するかどうかを示します。
notify_attachment_html_format boolean notify_attachment が true の場合、レポートを HTML 形式の電子メールで送信するかどうかを示します。
notify_attachment_pdf_format boolean notify_attachment が true の場合、レポートを PDF 形式の電子メールで送信するかどうかを示します。

レスポンス コード

ステータス コード 説明
200 成功。レポートはレスポンスの一部として返されます
403 TestRail Enterprise のみ。アクセスが拒否されました。ユーザー ロールがアクセスを許可していません。
429 TestRail Cloud のみ—リクエストが多すぎます (API レート制限を参照)

run_cross_project_report

report_template_id パラメーターで指定されたレポートを実行し、HTML および PDF フォーマットのレポートにアクセスするための URL を返します。Enterprise ライセンス でのみ利用可能です。

GET index.php?/api/v2/run_cross_project_report/{report_template_id}

レスポンスの内容

{
    "report_url": "https://docs.testrail.com/index.php?/cross_project_reports/view/383",
    "report_html": "https://docs.testrail.com/index.php?/cross_project_reports/get_html/383",
    "report_pdf": "https://docs.testrail.com/index.php?/cross_project_reports/get_pdf/383"
}

レスポンス コード

ステータス コード 説明
200 成功。レポートはレスポンスの一部として返されます
400 無効なレポート テンプレート ID です
403 プロジェクトにアクセス不可
429 TestRail Cloud のみ—リクエストが多すぎます (API レート制限を参照)