از موارد زیر استفاده کنید API روشهایی برای درخواست جزئیات درباره مجموعههای آزمایشی و ایجاد یا اصلاح مجموعههای آزمایشی.
get_suite #
مجموعه آزمایشی موجود را برمیگرداند.
GET index.php?/api/v2/get_suite/{suite_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| suite_id | عدد صحیح | درست است | شناسه مجموعه آزمایشی |
محتوای پاسخگویی #
لطفاً برای پاسخ نمونه معمولی زیر را ببینید:
{
"description": "..",
"id": 1,
"name": "Setup & Installation",
"project_id": 1,
"url": "http:///testrail/index.php?/suites/view/1"
}
فیلدهای زیر در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| تکمیل_روشن | مهر زمانی | تاریخ/زمان بسته شدن مجموعه آزمایشی (به عنوان مهر زمانی یونیکس) (با TestRail ۴.۰ اضافه شد) |
| توضیحات | رشته | توضیحات مجموعه تست |
| شناسه | عدد صحیح | شناسه منحصر به فرد مجموعه آزمایشی |
| is_baseline | بولی | اگر مجموعه آزمایشی مجموعه آزمایشی پایه باشد صحیح است و در غیر این صورت نادرست است (به TestRail ۴.۰ اضافه شده است) |
| is_completed | بولی | درست است اگر مجموعه آزمایشی بهعنوان تکمیل/بایگانی شده علامتگذاری شده باشد و در غیر این صورت نادرست است (به TestRail ۴.۰ اضافه شده است) |
| is_master | بولی | اگر مجموعه آزمایشی مجموعه آزمایشی اصلی باشد صحیح است و در غیر این صورت نادرست است (به TestRail ۴.۰ اضافه شده است) |
| حد / جبران | عدد صحیح | نتیجه را به محدود کردن مجموعه های آزمایشی محدود کنید. برای رد کردن رکوردها از افست استفاده کنید |
| نام | رشته | نام مجموعه آزمایشی |
| پروژه_id | عدد صحیح | شناسه پروژه ای که این مجموعه آزمایشی به آن تعلق دارد |
| آدرس اینترنتی | رشته | آدرس/URL مجموعه آزمایشی در رابط کاربری |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (مجموعه آزمایشی به عنوان بخشی از پاسخ بازگردانده می شود) |
| 400 | مجموعه آزمایشی نامعتبر یا ناشناخته |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
get_suites #
فهرستی از مجموعه های آزمایشی را برای یک پروژه برمی گرداند.
GET index.php?/api/v2/get_suites/{project_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پروژه_id | عدد صحیح | درست است | شناسه پروژه |
{
"offset": 0,
"limit": 250,
"size": 250,
"_links": {
"next": "/api/v2/get_cases/1&limit=250&offset=250",
"prev": null
},
"suites": [ { "id": 1, "name": "Setup & Installation", }, { "id": 2, "name": "Document Editing", }, ]
}
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (مجموعه های آزمایشی به عنوان بخشی از پاسخ بازگردانده می شوند) |
| 400 | پروژه نامعتبر یا ناشناخته |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
تغییر در نقطه پایانی get_suites از TestRail ۹.۳.۱ به بعد، زیرا برای پشتیبانی از صفحه بندی به روز شد.
add_suite #
یک مجموعه آزمایشی جدید ایجاد می کند.
POST index.php?/api/v2/add_suite/{project_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پروژه_id | عدد صحیح | درست است | شناسه پروژه مجموعه آزمایشی باید به آن اضافه شود |
درخواست بدن #
فیلدهای زیر در بدنه درخواست POST پشتیبانی می شوند:
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| نام | رشته | درست است | نام مجموعه آزمایشی |
| توضیحات | رشته | نادرست | توضیحات مجموعه تست |
درخواست نمونه #
همچنین مثال زیر را ببینید که نحوه ایجاد یک مجموعه آزمایشی جدید و خالی را نشان می دهد:
{
"name": "This is a new test suite",
"description": "Use the description to add additional context details"
}
هنگامی که یک مجموعه آزمایشی را اضافه کردید، می توانید شروع به اضافه کردن کنید بخش ها و تستکیسها.
محتوای پاسخگویی #
در صورت موفقیت آمیز بودن، این روش مجموعه آزمایشی جدید را با استفاده از همان قالب پاسخ بازمی گرداند get_suite.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (مجموعه آزمایشی ایجاد شد و به عنوان بخشی از پاسخ بازگردانده شد) |
| 400 | پروژه نامعتبر یا ناشناخته |
| 403 | بدون مجوز برای افزودن مجموعه آزمایشی یا عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
update_suite #
یک مجموعه آزمایشی موجود را بهروزرسانی میکند (بهروزرسانیهای جزئی پشتیبانی میشوند، یعنی فقط میتوانید فیلدهای خاص را ارسال و بهروزرسانی کنید).
POST index.php?/api/v2/update_suite/{suite_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| suite_id | عدد صحیح | درست است | شناسه مجموعه آزمایشی |
این روش از همان فیلدهای POST پشتیبانی می کند add_suite.
محتوای پاسخگویی #
در صورت موفقیت آمیز بودن، این روش مجموعه آزمایشی به روز شده را با استفاده از همان قالب پاسخ بازمی گرداند get_suite.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (مجموعه آزمایشی به روز شد و به عنوان بخشی از پاسخ بازگردانده شد) |
| 400 | مجموعه آزمایشی نامعتبر یا ناشناخته |
| 403 | هیچ مجوزی برای تغییر مجموعههای آزمایشی یا عدم دسترسی به پروژه وجود ندارد |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
delete_suite #
#
حذف مجموعه آزمایشی قابل واگرد نیست و همچنین تمام اجرای تست فعال را حذف می کند & نتایج، یعنی اجرای تست & نتایجی که هنوز بسته نشده اند (بایگانی شده اند).
مجموعه آزمایشی موجود را حذف می کند.
POST index.php?/api/v2/delete_suite/{suite_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| suite_id | عدد صحیح | درست است | شناسه مجموعه آزمایشی |
پارامتر نرم #
#
حذف پارامتر نرمافزار، یا ارسال soft=۰، مجموعه آزمایشی و تستکیسها آن را حذف میکند
اگر soft=۱ باشد، دادههای مربوط به تعداد تستها، موارد و غیره را برمیگرداند.
از جمله soft=۱ در واقع موجودیت را حذف نمی کند.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (مجموعه آزمایشی و همه اجراهای آزمایشی فعال و نتایج حذف شدند) |
| 400 | مجموعه آزمایشی نامعتبر یا ناشناخته |
| 403 | بدون مجوز برای حذف مجموعه های آزمایشی یا عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |

