از موارد زیر استفاده کنید API روش هایی برای درخواست جزئیات در مورد بخش ها و ایجاد یا تغییر بخش ها. بخش ها برای گروه بندی و سازماندهی تستکیسها در مجموعه های آزمایشی استفاده می شوند.
get_section #
بخش موجود را برمیگرداند.
GET index.php?/api/v2/get_section/{section_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| section_id | عدد صحیح | درست است | شناسه بخش |
محتوای پاسخگویی #
لطفاً برای پاسخ معمولی زیر را ببینید:
{
"depth": 0,
"description": null,
"display_order": 1,
"id": 1,
"name": "Prerequisites",
"parent_id": null,
"suite_id": 1
}
فیلدهای زیر در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| عمق | عدد صحیح | سطح در سلسله مراتب بخش مجموعه آزمون |
| توضیحات | رشته | توضیحات بخش |
| display_order | عدد صحیح | سفارش در مجموعه آزمایشی |
| شناسه | عدد صحیح | شناسه منحصر به فرد بخش |
| parent_id | عدد صحیح | شناسه بخش والد در مجموعه آزمایشی |
| نام | رشته | نام بخش |
| suite_id | عدد صحیح | شناسه مجموعه آزمایشی این بخش به آن تعلق دارد |
را depth، display_order و parent فیلدها سلسله مراتب بخش ها را در مجموعه آزمایشی تعیین می کنند. را depth فیلد برای همه بخش ها در سطح ریشه ۰ و برای همه بخش های فرزند بزرگتر از ۰ است. را depth فیلد، بنابراین، شبیه سطح در سلسله مراتب بخش است. همچنین، ببینید get_sections برای مثال
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (بخش به عنوان بخشی از پاسخ برگردانده می شود) |
| 400 | بخش نامعتبر یا ناشناخته |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
get_sections #
فهرستی از بخشهای یک پروژه و مجموعه آزمایشی را برمیگرداند.
GET index.php?/api/v2/get_sections/{project_id}&suite_id={suite_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پروژه_id | عدد صحیح | درست است | شناسه پروژه |
| suite_id | عدد صحیح | توضیحات را ببینید | شناسه مجموعه آزمایشی (در صورتی که پروژه در حالت تک مجموعه کار می کند اختیاری است) |
درخواست فیلتر #
فیلترهای زیر را می توان با استفاده از پارامترهای پرس و جو در URL درخواست اعمال کرد:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| محدود کردن | عدد صحیح | تعداد بخش هایی که پاسخ باید برگرداند (اندازه پاسخ به طور پیش فرض ۲۵۰ است) – به TestRail ۶.۷ یا بالاتر نیاز دارد |
| جبران | عدد صحیح | از کجا باید شمارش بخش ها را شروع کرد (افست) – به TestRail ۶.۷ یا بالاتر نیاز دارد |
محتوای پاسخ #
لطفاً برای یک مثال معمولی زیر را ببینید:
{
"offset": 0,
"limit": 250,
"size": 23,
"_links": {
"next": null,
"prev": null
},
"sections": [
{
"depth": 0,
"display_order": 1,
"id": 1,
"name": "Prerequisites",
"parent_id": null,
"suite_id": 1
},
{
"depth": 0,
"display_order": 2,
"id": 2,
"name": "Documentation & Help",
"parent_id": null,
"suite_id": 1
},
{
"depth": 1, // A child section
"display_order": 3,
"id": 3,
"name": "Licensing & Terms",
"parent_id": 2, // Points to the parent section
"suite_id": 1
}
]
}
همچنین، ببینید get_section برای جزئیات بیشتر در مورد فیلدهای موجود
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (بخش ها به عنوان بخشی از پاسخ بازگردانده می شوند) |
| 400 | پروژه یا مجموعه آزمایشی نامعتبر یا ناشناخته |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
add_section #
یک بخش جدید ایجاد می کند.
POST index.php?/api/v2/add_section/{project_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پروژه_id | عدد صحیح | درست است | شناسه پروژه |
درخواست بدن #
فیلدهای زیر در بدنه درخواست POST پشتیبانی می شوند:
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| توضیحات | رشته | نادرست | توضیحات بخش |
| suite_id | عدد صحیح | توضیحات را ببینید | شناسه مجموعه آزمایشی (اگر پروژه در حالت تک مجموعه کار می کند نادیده گرفته می شود، در غیر این صورت لازم است) |
| parent_id | عدد صحیح | نادرست | شناسه بخش والد (برای ساخت سلسله مراتب بخش) |
| نام | رشته | درست است | نام بخش |
درخواست نمونه #
همچنین مثال زیر را مشاهده کنید که نحوه ایجاد یک بخش جدید و خالی را نشان می دهد (با استفاده از بخش ایجاد شده قبلی به عنوان والد):
{
"suite_id": 5,
"name": "This is a new section",
"parent_id": 10
}
هنگامی که یک بخش را اضافه کردید، می توانید شروع به اضافه کردن کنید تستکیسها.
محتوای پاسخگویی #
در صورت موفقیت آمیز بودن، این روش بخش جدید را با استفاده از همان قالب پاسخ باز می گرداند get_section.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (بخش ایجاد شد و به عنوان بخشی از پاسخ بازگردانده شد) |
| 400 | پروژه یا مجموعه آزمایشی نامعتبر یا ناشناخته |
| 403 | بدون مجوز برای افزودن بخش یا عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
move_section #
#
این نقطه پایانی به TestRail ۶.۵.۲ یا بالاتر نیاز دارد.
یک بخش را به مجموعه یا بخش دیگری منتقل می کند.
POST index.php?/api/v2/move_section/{section_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| section_id | عدد صحیح | درست است | شناسه بخش |
درخواست بدن #
فیلدهای زیر در بدنه درخواست POST پشتیبانی می شوند:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| parent_id | عدد صحیح | شناسه بخش والد (اگر باید به ریشه منتقل شود، می تواند تهی باشد). باید در همان پروژه و مجموعه باشد. ممکن است فرزند مستقیم بخشی نباشد که منتقل می شود. |
| after_id | عدد صحیح | شناسه بخش که بعد از آن بخش باید قرار داده شود (می تواند تهی باشد) |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | با موفقیت (بخش منتقل شد و به عنوان بخشی از پاسخ برگردانده شد) |
| 400 | Section_id، parent_id، یا after_id نامعتبر یا ناشناخته است |
| 403 | بدون مجوز برای افزودن بخش یا عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
update_section #
یک بخش موجود را بهروزرسانی میکند (بهروزرسانیهای جزئی پشتیبانی میشوند، یعنی فقط میتوانید فیلدهای خاص را ارسال و بهروزرسانی کنید).
POST index.php?/api/v2/update_section/{section_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| section_id | عدد صحیح | درست است | شناسه بخش |
درخواست بدن #
فیلدهای زیر در بدنه درخواست POST پشتیبانی می شوند:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| توضیحات | رشته | توضیحات بخش |
| نام | رشته | نام بخش |
درخواست نمونه #
همچنین، مثال زیر را ببینید که نحوه به روز رسانی نام یک بخش موجود را نشان می دهد:
{
"name": "A better section name"
}
محتوای پاسخگویی #
در صورت موفقیت آمیز بودن، این روش بخش به روز شده را با استفاده از همان قالب پاسخ باز می گرداند get_section.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | با موفقیت (بخش به روز شد و به عنوان بخشی از پاسخ بازگردانده شد) |
| 400 | بخش نامعتبر یا ناشناخته |
| 403 |
بدون مجوز برای تغییر بخش ها یا عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
delete_section #
#
حذف یک بخش قابل بازگشت نیست و همچنین تمام تستکیسها مرتبط و همچنین تست های فعال را حذف می کند & نتایج، یعنی آزمایشات & نتایجی که هنوز بسته نشده اند (بایگانی شده اند).
یک بخش موجود را حذف می کند.
POST index.php?/api/v2/delete_section/{section_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| section_id | عدد صحیح | درست است | شناسه بخش |
پارامتر نرم #
#
حذف پارامتر نرم افزار یا ارسال soft=۰ بخش و تستکیسها آن را حذف می کند
اگر soft=۱ باشد، دادههای مربوط به تعداد تستها، موارد و غیره را برمیگرداند.
گنجاندن soft=۱ واقعاً موجودیت را در TestRail UI حذف نمیکند و خروجی فقط در پاسخ API نشان داده میشود.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | با موفقیت (بخش حذف شد) |
| 400 | بخش نامعتبر یا ناشناخته |
| 403 | بدون مجوز برای حذف بخش ها یا تستکیسها یا عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |

