از موارد زیر استفاده کنید API روش های آپلود، بازیابی و حذف پیوست ها
هنگام آپلود پیوست ها از طریق TestRail باید از سرصفحه های زیر استفاده شود API با استفاده از درخواست های POST:
Content-Type: multipart/form-data
پیوست باید به عنوان داده های فرم در متن درخواست ارسال شود. لطفا ما را مرور کنید دسترسی به API اسناد یا اتصالات TestRail برای نمونه هایی از ارسال پیوست.
#
پس از انتشار TestRail ۷.۱ (ابر)، سیستم مدیریت پیوست کمی تغییر کرد. فرمت جدیدی برای شناسه پیوست معرفی شده است. لطفا اینجا را بررسی کنید: مقدمه ای بر TestRail API
add_tachment_to_case #
#
این نقطه پایانی به TestRail ۶.۵.۲ یا بالاتر نیاز دارد.
پیوستی را به طرح آزمایشی اضافه می کند. حداکثر اندازه مجاز بارگذاری روی ۲۵۶ مگابایت تنظیم شده است.
POST index.php?/api/v2/add_attachment_to_case/{case_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| case_id | عدد صحیح | درست است | شناسه پرونده آزمایشی پیوست باید به آن اضافه شود. |
محتوای پاسخگویی #
لطفاً برای پاسخ معمولی زیر را ببینید:
{
"attachment_id": 443
}
فیلدهای سیستم زیر همیشه در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| پیوست_id | عدد صحیح | شناسه پیوست آپلود شده در TestRail |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | با موفقیت (شناسه پیوست در پاسخ بازگردانده می شود) |
| 400 | تستکیس نامعتبر یا ناشناخته |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
add_tachment_to_plan #
#
این نقطه پایانی به TestRail ۶.۳ یا بالاتر نیاز دارد.
پیوستی را به طرح آزمایشی اضافه می کند. حداکثر اندازه مجاز بارگذاری روی ۲۵۶ مگابایت تنظیم شده است.
POST index.php?/api/v2/add_attachment_to_plan/{plan_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| plan_id | عدد صحیح | درست است | شناسه طرح آزمون پیوست باید به آن اضافه شود. |
محتوای پاسخگویی #
لطفاً برای پاسخ معمولی زیر را ببینید:
{
"attachment_id": 443
}
فیلدهای سیستم زیر همیشه در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| پیوست_id | عدد صحیح | شناسه پیوست آپلود شده در TestRail |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | با موفقیت (شناسه پیوست در پاسخ بازگردانده می شود) |
| 400 | طرح آزمایشی نامعتبر یا ناشناخته |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
add_tachment_to_plan_entry #
#
این نقطه پایانی به TestRail ۶.۳ یا بالاتر نیاز دارد.
پیوستی را به طرح آزمایشی اضافه می کند. حداکثر اندازه مجاز بارگذاری روی ۲۵۶ مگابایت تنظیم شده است.
POST index.php?/api/v2/add_attachment_to_plan_entry/{plan_id}/{entry_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| plan_id | عدد صحیح | درست است | شناسه طرح آزمون حاوی ورودی |
| ورود_id | عدد صحیح | درست است | شناسه ورودی طرح آزمون که پیوست باید به آن اضافه شود |
محتوای پاسخگویی #
لطفاً برای پاسخ معمولی زیر را ببینید:
{
"attachment_id": 443
}
فیلدهای سیستم زیر همیشه در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| پیوست_id | عدد صحیح | شناسه پیوست آپلود شده در TestRail |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | با موفقیت (شناسه پیوست در پاسخ بازگردانده می شود) |
| 400 | درخواست POST به درستی قالب بندی نشده است یا پارامتر(های) شناسه نامعتبر است |
| 403 | عدم دسترسی به پروژه یا مجوزهای ناکافی |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
add_tachment_to_result #
POST index.php?/api/v2/add_attachment_to_result/{result_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| result_id | عدد صحیح | درست است | شناسه نتیجه آزمون که پیوست باید به آن اضافه شود |
را ببینید اسناد API نتایج برای جزئیات نحوه به دست آوردن:result_id’s.
محتوای پاسخگویی #
لطفاً برای پاسخ معمولی زیر را ببینید:
{
"attachment_id": 443
}
فیلدهای سیستم زیر همیشه در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| پیوست_id | عدد صحیح | شناسه پیوست آپلود شده در TestRail |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | با موفقیت (شناسه پیوست در پاسخ بازگردانده می شود) |
| 400 | درخواست POST به درستی قالب بندی نشده است یا شناسه نتیجه نامعتبر است |
| 403 | عدم دسترسی به پروژه یا مجوزهای ناکافی |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
add_attachment_to_run #
#
این نقطه پایانی به TestRail ۶.۳ یا بالاتر نیاز دارد.
یک پیوست را به اجرای تست اضافه می کند. حداکثر اندازه مجاز بارگذاری روی ۲۵۶ مگابایت تنظیم شده است.
POST index.php?/api/v2/add_attachment_to_run/{run_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| run_id | عدد صحیح | درست است | شناسه اجرای تست پیوست باید به آن اضافه شود |
محتوای پاسخگویی #
لطفاً برای پاسخ معمولی زیر را ببینید:
{
"attachment_id": 443
}
فیلدهای سیستم زیر همیشه در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| پیوست_id | عدد صحیح | شناسه پیوست آپلود شده در TestRail |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | با موفقیت (شناسه پیوست در پاسخ بازگردانده می شود) |
| 400 | درخواست POST به درستی قالب بندی نشده است یا شناسه اجرا نامعتبر است |
| 403 | عدم دسترسی به پروژه یا مجوزهای ناکافی |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
get_attachments_for_case #
#
این نقطه پایانی به TestRail ۵.۷ یا بالاتر نیاز دارد.
فهرستی از پیوستها را برای یک تستکیس برمیگرداند.
GET index.php?/api/v2/get_attachments_for_case/{case_id}&limit={limit}&offset={offset}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| case_id | عدد صحیح | درست است | شناسه تستکیس برای بازیابی پیوستها |
درخواست فیلتر #
فیلترهای زیر را می توان اعمال کرد:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| محدود کردن | عدد صحیح | تعداد پیوست هایی که پاسخ باید برگرداند (اندازه پاسخ به طور پیش فرض ۲۵۰ است) – به TestRail ۶.۷ یا بالاتر نیاز دارد |
| جبران | عدد صحیح | از کجا باید شمارش پیوستها را از (اوفست) شروع کرد – به TestRail ۶.۷ یا بالاتر نیاز دارد |
محتوای پاسخ #
لطفاً برای پاسخ معمولی زیر را ببینید:
{
"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
}
]
}
#
پس از انتشار TestRail ۷.۱ (ابر)، سیستم مدیریت پیوست کمی تغییر کرد. فرمت جدیدی برای شناسه پیوست معرفی شده است. لطفا اینجا را بررسی کنید: API – شروع به کار
{
"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"
}
]
}
فیلدهای سیستم زیر همیشه در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| شناسه | عدد صحیح | شناسه منحصر به فرد پیوست |
| نام | رشته | نام پیوست |
| اندازه | عدد صحیح | اندازه پیوست بر حسب بایت |
| ایجاد_روشن | مهر زمانی | زمان/تاریخ آپلود پیوست |
| پروژه_id | عدد صحیح | شناسه پروژه ای که پیوست بر روی آن آپلود شده است |
| case_id | عدد صحیح | شناسه موردی که پیوست به آن تعلق دارد |
| user_id | عدد صحیح | شناسه کاربری که پیوست را آپلود کرده است |
| result_id | عدد صحیح | شناسه نتیجه آزمون که پیوست به آن تعلق دارد |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (آرایه ای از جزئیات پیوست در پاسخ بازگردانده می شود) |
| 400 | شناسه تستکیس نامعتبر است |
| 403 | عدم دسترسی به پروژه یا مجوزهای ناکافی |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
دریافت_پیوست_برای_طرح #
#
این نقطه پایانی به TestRail ۶.۳ یا بالاتر نیاز دارد.
فهرستی از پیوستها را برای طرح آزمایشی برمیگرداند.
GET index.php?/api/v2/get_attachments_for_plan/{plan_id}&limit={limit}&offset={offset}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| plan_id | عدد صحیح | درست است | شناسه طرح آزمایشی برای بازیابی پیوستها از |
درخواست فیلتر #
فیلترهای زیر را می توان اعمال کرد:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| محدود کردن | عدد صحیح | تعداد پیوست هایی که پاسخ باید برگرداند (اندازه پاسخ به طور پیش فرض ۲۵۰ است) –به TestRail ۶.۷ یا بالاتر نیاز دارد |
| جبران | عدد صحیح | شمارش پیوستها را از کجا شروع کنیم (افست) – به TestRail ۶.۷ یا بالاتر نیاز دارد |
محتوای پاسخ #
لطفاً برای پاسخ معمولی زیر را ببینید:
[
{
"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 | عدد صحیح | شناسه پروژه ای که پیوست بر روی آن آپلود شده است |
| case_id | عدد صحیح | شناسه موردی که پیوست به آن تعلق دارد |
| user_id | عدد صحیح | شناسه کاربری که پیوست را آپلود کرده است |
| entity_attachments_id | عدد صحیح | شناسه رکورد پیوست (نه شناسه خود پیوست) |
| icon_name | رشته | نام نماد استفاده شده در رابط کاربری TestRail |
| result_id | عدد صحیح | شناسه نتیجه آزمون که پیوست به آن تعلق دارد |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (آرایه ای از جزئیات پیوست در پاسخ برگردانده می شود) |
| 400 | شناسه آزمون نامعتبر است |
| 403 | عدم دسترسی به پروژه یا مجوزهای ناکافی |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
get_attachments_for_plan_entry #
#
این نقطه پایانی به TestRail ۶.۳ یا بالاتر نیاز دارد.
فهرستی از پیوستها را برای ورودی طرح آزمایشی برمیگرداند.
GET index.php?/api/v2/get_attachments_for_plan_entry/{plan_id}/{entry_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| plan_id | عدد صحیح | درست است | شناسه طرح آزمون حاوی ورودی |
| ورود_id | عدد صحیح | درست است | شناسه ورودی طرح آزمایشی برای بازیابی پیوستها از |
این روش همان قالب پاسخ را به عنوان get_attachments_for_plan برمی گرداند.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (آرایه ای از جزئیات پیوست در پاسخ برگردانده می شود) |
| 400 | شناسه آزمون نامعتبر است |
| 403 | عدم دسترسی به پروژه یا مجوزهای ناکافی |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
get_attachments_for_run #
#
این نقطه پایانی به TestRail ۶.۳ یا بالاتر نیاز دارد.
فهرستی از پیوستها را برای اجرای تست برمیگرداند.
GET index.php?/api/v2/get_attachments_for_run/{run_id}?limit={limit}&offset={offset}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| run_id | عدد صحیح | درست است | شناسه اجرای تست برای بازیابی پیوستها از |
این روش همان قالب پاسخ را به عنوان get_attachments_for_plan برمی گرداند.
درخواست فیلتر #
فیلترهای زیر را می توان اعمال کرد:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| محدود کردن | عدد صحیح | تعداد پیوست هایی که پاسخ باید برگرداند (اندازه پاسخ به طور پیش فرض ۲۵۰ است) –به TestRail ۶.۷ یا بالاتر نیاز دارد |
| جبران | عدد صحیح | شمارش پیوستها را از کجا شروع کنیم (افست) – به TestRail ۶.۷ یا بالاتر نیاز دارد |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (آرایه ای از جزئیات پیوست در پاسخ برگردانده می شود) |
| 400 | شناسه آزمون نامعتبر است |
| 403 | عدم دسترسی به پروژه یا مجوزهای ناکافی |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
get_attachments_for_test #
#
این نقطه پایانی به TestRail ۵.۷ یا بالاتر نیاز دارد.
فهرستی از پیوستها را برای نتایج یک آزمون برمیگرداند.
GET index.php?/api/v2/get_attachments_for_test/{test_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| test_id | عدد صحیح | درست است | شناسه آزمون برای بازیابی پیوست ها از |
این روش همان قالب پاسخ را به عنوان get_attachments_for_case برمی گرداند.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (آرایه ای از جزئیات پیوست در پاسخ برگردانده می شود) |
| 400 | شناسه آزمون نامعتبر است |
| 403 | عدم دسترسی به پروژه یا مجوزهای ناکافی |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
get_tachment #
#
این نقطه پایانی به TestRail ۵.۷ یا بالاتر نیاز دارد.
فایل درخواستی شناسایی شده توسط را بازیابی می کند attachment_id.
GET index.php?/api/v2/get_attachment/{attachment_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پیوست_id | عدد صحیح | درست است | شناسه آزمون برای بازیابی پیوست ها از |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (پیوست در متن پاسخ برگردانده می شود) |
| 400 | شناسه پیوست نامعتبر است |
| 403 | عدم دسترسی به پروژه یا مجوزهای ناکافی |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
delete_tachment #
#
این نقطه پایانی به TestRail ۵.۷ یا بالاتر نیاز دارد.
پیوست مشخص شده توسط attachment_id.
POST index.php?/api/v2/delete_attachment/{attachment_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پیوست_id | عدد صحیح | درست است | شناسه پیوست برای حذف |
محتوای پاسخگویی #
یک POST delete_attachment موفق، بدنه پاسخ خالی را با کد پاسخ ۲۰۰ برمی گرداند.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | با موفقیت (پیوست حذف شد) |
| 400 | شناسه پیوست نامعتبر است |
| 403 | عدم دسترسی به پروژه یا مجوزهای ناکافی |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |

