برای درخواست جزئیات درباره test suiteها و ایجاد یا ویرایش آنها، از متدهای زیر API استفاده کنید.
get_suite #
یک test suite موجود را برمیگرداند.
GET index.php?/api/v2/get_suite/{suite_id}پارامترها #
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| suite_id | integer | true | ID test suite |
محتوای پاسخ #
در ادامه یک نمونه پاسخ معمولی را میبینید:
{
"description": "..",
"id": 1,
"name": "Setup & Installation",
"project_id": 1,
"url": "http:///testrail/index.php?/suites/view/1"
}فیلدهای زیر در پاسخ برگردانده میشوند:
| نام | نوع | توضیحات |
|---|---|---|
| completed_on | timestamp | تاریخ و زمان بسته شدن test suite، بهصورت UNIX timestamp (در TestRail ۴.۰ اضافه شده است) |
| description | string | توضیحات test suite |
| id | integer | ID یکتای test suite |
| is_baseline | boolean | اگر test suite از نوع baseline باشد مقدار آن true است؛ در غیر این صورت false است (در TestRail ۴.۰ اضافه شده است) |
| is_completed | boolean | اگر test suite بهعنوان completed/archived علامتگذاری شده باشد مقدار آن true است؛ در غیر این صورت false است (در TestRail ۴.۰ اضافه شده است) |
| is_master | boolean | اگر test suite از نوع master باشد مقدار آن true است؛ در غیر این صورت false است (در TestRail ۴.۰ اضافه شده است) |
| limit/offset | integer | نتیجه را به تعداد مشخصشده در limit از test suiteها محدود کنید. برای رد کردن رکوردها از offset استفاده کنید |
| name | string | نام test suite |
| project_id | integer | ID projectی که این test suite به آن تعلق دارد |
| url | string | آدرس یا URL test suite در رابط کاربری |
کدهای پاسخ #
| کد status | توضیحات |
|---|---|
| 200 | موفقیتآمیز (test suite در پاسخ برگردانده میشود) |
| 400 | test suite نامعتبر یا ناشناخته |
| 403 | به project دسترسی ندارید |
| 429 | فقط TestRail Cloud– تعداد درخواستها بیش از حد مجاز است (ببینید محدودیت نرخ API) |
get_suites #
فهرست test suiteهای یک project را برمیگرداند.
GET index.php?/api/v2/get_suites/{project_id}پارامترها #
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| project_id | integer | true | ID project |
{
"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", }, ]
}
کدهای پاسخ #
| کد status | توضیحات |
|---|---|
| 200 | موفقیتآمیز (test suiteها در پاسخ برگردانده میشوند) |
| 400 | project نامعتبر یا ناشناخته |
| 403 | به project دسترسی ندارید |
| 429 | فقط TestRail Cloud– تعداد درخواستها بیش از حد مجاز است (ببینید محدودیت نرخ API) |
از TestRail ۹.۳.۱ به بعد، در endpoint get_suites یک breaking change وجود دارد؛ چون برای پشتیبانی از pagination بهروزرسانی شده است.
add_suite #
یک test suite جدید ایجاد میکند.
POST index.php?/api/v2/add_suite/{project_id}پارامترها #
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| project_id | integer | true | ID projectی که test suite باید به آن اضافه شود |
بدنه درخواست #
فیلدهای زیر در بدنه درخواست POST پشتیبانی میشوند:
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| name | string | true | نام test suite |
| description | string | false | توضیحات test suite |
نمونه درخواست #
مثال زیر نشان میدهد چگونه یک test suite جدید و خالی ایجاد کنید:
{
"name": "This is a new test suite",
"description": "Use the description to add additional context details"
}
بعد از اضافه کردن test suite، میتوانید اضافه کردن sectionها و test caseها را شروع کنید.
محتوای پاسخ #
در صورت موفقیت، این متد test suite جدید را با همان قالب پاسخ get_suite برمیگرداند.
کدهای پاسخ #
| کد status | توضیحات |
|---|---|
| 200 | موفقیتآمیز (test suite ایجاد شده و در پاسخ برگردانده میشود) |
| 400 | project نامعتبر یا ناشناخته |
| 403 | مجوز افزودن test suite را ندارید یا به project دسترسی ندارید |
| 429 | فقط TestRail Cloud– تعداد درخواستها بیش از حد مجاز است (ببینید محدودیت نرخ API) |
update_suite #
یک test suite موجود را بهروزرسانی میکند. بهروزرسانی جزئی پشتیبانی میشود؛ یعنی میتوانید فقط فیلدهای مشخصی را ارسال و بهروزرسانی کنید.
POST index.php?/api/v2/update_suite/{suite_id}پارامترها #
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| suite_id | integer | true | ID test suite |
این متد از همان فیلدهای POST در add_suite پشتیبانی میکند.
محتوای پاسخ #
در صورت موفقیت، این متد test suite بهروزرسانیشده را با همان قالب پاسخ get_suite برمیگرداند.
کدهای پاسخ #
| کد status | توضیحات |
|---|---|
| 200 | موفقیتآمیز (test suite بهروزرسانی شده و در پاسخ برگردانده میشود) |
| 400 | test suite نامعتبر یا ناشناخته |
| 403 | مجوز تغییر test suiteها را ندارید یا به project دسترسی ندارید |
| 429 | فقط TestRail Cloud– تعداد درخواستها بیش از حد مجاز است (ببینید محدودیت نرخ API) |
delete_suite #
#
حذف test suite قابل برگشت نیست و همه test runهای فعال و & نتایج آنها، یعنی نتایج test runهایی & را هم حذف میکند که هنوز بسته (archived) نشدهاند.
یک test suite موجود را حذف میکند.
POST index.php?/api/v2/delete_suite/{suite_id}پارامترها #
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| suite_id | integer | true | ID test suite |
parameter مربوط به soft #
#
اگر parameter مربوط به soft را وارد نکنید یا soft=۰ ارسال کنید، test suite و test caseهای آن حذف میشوند.
اگر soft=۱ باشد، دادههایی درباره تعداد testها، caseها و موارد مشابه تحت تأثیر برگردانده میشود.
با ارسال soft=۱، موجودیت واقعاً حذف نمیشود.
کدهای پاسخ #
| کد status | توضیحات |
|---|---|
| 200 | موفقیتآمیز (test suite و همه test runها و نتایج فعال حذف شدند) |
| 400 | test suite نامعتبر یا ناشناخته |
| 403 | مجوز حذف test suiteها را ندارید یا به project دسترسی ندارید |
| 429 | فقط TestRail Cloud– تعداد درخواستها بیش از حد مجاز است (ببینید محدودیت نرخ API) |
