از روش های زیر برای دریافت و اجرای گزارش های تک پروژه ای که در دسترس قرار گرفته اند استفاده کنید API.
قبل از دسترسی به گزارش از طریق API نقاط پایانی، باید گزارش خود را در دسترس قرار دهید API. می توانید این کار را با ایجاد یک گزارش جدید و بررسی آن انجام دهید ایجاد این گزارش: بر حسب تقاضا از طریق API چک باکس

#
شما نمی توانید آن را اصلاح کنید این گزارش را ایجاد کنید: تنظیمات پس از ذخیره گزارش بنابراین، نمیتوانید گزارشهای برنامهریزیشده موجود خود را تغییر دهید تا در دسترس باشند API.
پس از ایجاد گزارش و بررسی آن بر حسب تقاضا از طریق API چک باکس، گزارش در قسمت قابل مشاهده خواهد بود API قالب ها برگه بخش، در کنار گزارش های دیگر.

گزارش ها در API قالب ها بخش با استفاده از نقاط پایانی API که در زیر توضیح داده شده قابل مشاهده و اجرا هستند.
#
ممکن است گزارش بلافاصله پس از اجرا در دسترس نباشد و مدت زمانی که گزارش قبل از در دسترس شدن طول می کشد می تواند متفاوت باشد، به خصوص برای مشتریان TestRail Server.
get_reports #
فهرستی از گزارشهای تک پروژه API موجود بر اساس پروژه را برمیگرداند.
GET index.php?/api/v2/get_reports/{project_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پروژه_id | عدد صحیح | درست است | شناسه پروژه ای که برای آن فهرستی از گزارش های قابل دسترسی API می خواهید |
محتوای پاسخگویی #
لطفاً برای پاسخ معمولی زیر را ببینید:
[
{
"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
}
]
فیلدهای سیستم زیر همیشه در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| شناسه | عدد صحیح | شناسه منحصر به فرد برای گزارش |
| نام | رشته | نام گزارش |
| توضیحات | رشته | شرح گزارش |
| notify_user | بولی | نشان می دهد که آیا نویسنده باید پس از اجرای گزارش مطلع شود یا خیر |
| notify_link | بولی | نشان می دهد که آیا ایمیل هایی با پیوندهای گزارش باید ارسال شوند یا خیر |
| notify_link_recipients | رشته | لیست کاربرانی که گزارش باید برای آنها ارسال شود |
| notify_tachment | بولی | نشان می دهد که آیا گزارش باید به عنوان پیوست ایمیل شود |
| notify_attachment_html_format | بولی | نشان می دهد که آیا گزارش باید در قالب HTML ایمیل شود، اگر پیوست notify_ درست باشد |
| notify_attachment_pdf_format | بولی | نشان می دهد که آیا گزارش باید در قالب PDF ایمیل شود، اگر پیوست notify_ درست باشد |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (گزارش ها در پاسخ بازگردانده می شوند) |
| 400 | پروژه نامعتبر یا ناشناخته |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
#
run_report #
#
این نقطه پایانی به TestRail ۵.۷ یا بالاتر نیاز دارد.
گزارش شناسایی شده را با استفاده از report_id پارامتر و برمی گرداند URLبرای دسترسی به گزارش در HTML و فرمت PDF
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 | شناسه الگوی گزارش نامعتبر است |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
get_cross_project_reports #
همه گزارشهای بین پروژهای موجود API را که کاربر به آنها دسترسی دارد – در دسترس است، برمیگرداند طرح های مجوز سازمانی فقط
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
}
]
فیلدهای سیستم زیر همیشه در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| شناسه | عدد صحیح | شناسه منحصر به فرد برای گزارش |
| نام | رشته | نام گزارش |
| توضیحات | رشته | شرح گزارش |
| project_ids | فهرست | لیست شناسه های پروژه موجود در گزارش |
| user_ids | فهرست |
لیست شناسه های کاربری موجود در گزارش فقط برای بار کاری کاربر در دسترس است |
| include_elapsed_test_time | بولی |
این که آیا زمان سپری شده آزمون لحاظ شده است یا خیر فقط برای بار کاری کاربر در دسترس است |
| include_estimated_test_time | بولی |
اینکه آیا زمان تخمینی آزمون گنجانده شده است یا خیر فقط برای بار کاری کاربر در دسترس است |
| مرتب سازی بر اساس | رشته |
شامل گزینه مرتب سازی انتخاب شده است فقط برای بار کاری کاربر در دسترس است |
| include_open_milestones | بولی | آیا نقاط عطف باز گنجانده شده است |
| include_completed_milestones | بولی | آیا نقاط عطف تکمیل شده گنجانده شده است |
| include_open_runs_and_plans | بولی | آیا اجراها و طرحهای باز گنجانده شدهاند |
| include_completed_runs_and_plans | بولی | آیا اجراها و طرحهای تکمیلشده گنجانده شدهاند |
| Report_timeframe | تاریخ | بازه زمانی انتخاب شده برای اجرای گزارش |
| شامل_وضعیت ها | فهرست | وضعیت های انتخاب شده برای اجرای گزارش |
| notify_user | بولی | نشان می دهد که آیا نویسنده باید پس از اجرای گزارش مطلع شود یا خیر |
| notify_link | بولی | نشان می دهد که آیا ایمیل هایی با پیوندهای گزارش باید ارسال شوند یا خیر |
| notify_link_recipients | رشته | لیست کاربرانی که گزارش باید برای آنها ارسال شود |
| notify_tachment | بولی | نشان می دهد که آیا گزارش باید به عنوان پیوست ایمیل شود |
| notify_attachment_html_format | بولی | نشان می دهد که آیا گزارش باید در قالب HTML ایمیل شود، اگر پیوست notify_ درست باشد |
| notify_attachment_pdf_format | بولی | نشان می دهد که آیا گزارش باید در قالب PDF ایمیل شود، اگر پیوست notify_ درست باشد |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (گزارش ها در پاسخ بازگردانده می شوند) |
| 403 |
فقط TestRail Enterprise. دسترسی رد شد. نقش کاربر اجازه دسترسی نمی دهد. |
| 429 |
فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
#
run_cross_project_report #
گزارش شناسایی شده را با استفاده از report_template_id پارامتر و برمی گرداند URLبرای دسترسی به گزارش در HTML و فرمت PDF – در دسترس برای طرح های مجوز سازمانی فقط
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 | شناسه الگوی گزارش نامعتبر است |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |

