از موارد زیر استفاده کنید API روشهایی برای درخواست جزئیات در مورد پیکربندیهای طرح آزمایشی و ایجاد یا اصلاح پیکربندیهای مورد استفاده برای تولید طرحهای آزمایشی.
get_configs #
فهرستی از پیکربندی های موجود را که بر اساس گروه های پیکربندی گروه بندی شده اند، برمی گرداند.
GET index.php?/api/v2/get_configs/{project_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پروژه_id | عدد صحیح | درست است | شناسه پروژه |
محتوای پاسخگویی #
پاسخ شامل آرایه ای از گروه های پیکربندی است که هر کدام لیستی از تنظیمات را دارند. لطفاً برای یک مثال معمولی زیر را ببینید:
[
{
"id": 1,
"name": "Browsers",
"project_id": 1,
"configs": [
{
"id": 3,
"name": "Chrome",
"group_id": 1
},
{
"id": 4,
"name": "Firefox ",
"group_id": 1
},
{
"id": 1,
"name": "IE 10",
"group_id": 1
},
{
"id": 2,
"name": "IE 11",
"group_id": 1
},
{
"id": 5,
"name": "Safari",
"group_id": 1
}
]
}
]
پاسخ مثال گروه های پیکربندی مرورگر مختلف را نشان می دهد:
| شناسه | پیکربندی |
|---|---|
| 1 | اینترنت اکسپلورر ۱۰ |
| 2 | اینترنت اکسپلورر ۱۱ |
| 3 | کروم |
| 4 | فایرفاکس |
| 5 | سافاری |
لطفا هم ببینید add_plan_entry و add_plan برای مثال در مورد نحوه استفاده از تنظیمات.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (پیکربندی ها به عنوان بخشی از پاسخ بازگردانده می شوند) |
| 400 | پروژه نامعتبر یا ناشناخته |
| 403 | عدم دسترسی به پروژه |
| 429 |
فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
add_config_group #
#
این نقطه پایانی به TestRail ۵.۲ یا بالاتر نیاز دارد.
یک گروه پیکربندی جدید ایجاد می کند.
POST index.php?/api/v2/add_config_group/{project_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پروژه_id | عدد صحیح | درست است | شناسه پروژه که گروه پیکربندی باید به آن اضافه شود |
درخواست بدن #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| نام | رشته | درست است | نام گروه پیکربندی |
درخواست نمونه #
همچنین، مثال زیر را ببینید که نحوه ایجاد یک گروه پیکربندی جدید را نشان می دهد:
{
"name": "Browsers"
}
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (گروه پیکربندی ایجاد شد و به عنوان بخشی از پاسخ برگردانده شد) |
| 400 | پروژه نامعتبر یا ناشناخته |
| 403 | بدون مجوز برای افزودن گروه های پیکربندی یا عدم دسترسی به پروژه |
| 429 |
فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
add_config #
#
این نقطه پایانی به TestRail ۵.۲ یا بالاتر نیاز دارد.
یک پیکربندی جدید ایجاد می کند.
POST index.php?/api/v2/add_config/{config_group_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| config_group_id | عدد صحیح | درست است | شناسه گروه پیکربندی که پیکربندی باید به آن اضافه شود |
درخواست بدن #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| نام | رشته | درست است | نام پیکربندی |
درخواست نمونه #
همچنین، مثال زیر را ببینید که نحوه ایجاد یک پیکربندی جدید را نشان می دهد:
{
"name": "Chrome"
}
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (گروه پیکربندی ایجاد شد و به عنوان بخشی از پاسخ برگردانده شد) |
| 400 | پروژه نامعتبر یا ناشناخته |
| 403 | بدون مجوز برای افزودن پیکربندی یا عدم دسترسی به پروژه |
| 429 |
فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
update_config_group #
#
این نقطه پایانی به TestRail ۵.۲ یا بالاتر نیاز دارد.
یک گروه پیکربندی موجود را به روز می کند.
POST index.php?/api/v2/update_config_group/{config_group_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| config_group_id | عدد صحیح | درست است | شناسه گروه پیکربندی |
درخواست بدن #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| نام | رشته | نادرست | نام گروه پیکربندی |
درخواست نمونه #
همچنین، مثال زیر را ببینید که نحوه به روز رسانی یک گروه پیکربندی را نشان می دهد:
{
"name": "Operating Systems"
}
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (گروه پیکربندی به روز شد و به عنوان بخشی از پاسخ بازگردانده شد) |
| 400 | گروه پیکربندی نامعتبر یا ناشناخته |
| 403 | بدون مجوز برای تغییر گروه های پیکربندی یا عدم دسترسی به پروژه |
| 429 |
فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
update_config #
#
این نقطه پایانی به TestRail ۵.۲ یا بالاتر نیاز دارد.
یک پیکربندی موجود را به روز می کند.
POST index.php?/api/v2/update_config/{config_id}
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (پیکربندی به روز شد و به عنوان بخشی از پاسخ بازگردانده شد) |
| 400 | پیکربندی نامعتبر یا ناشناخته |
| 403 | بدون مجوز برای تغییر تنظیمات یا عدم دسترسی به پروژه |
| 429 |
فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
delete_config_group #
#
این نقطه پایانی به TestRail ۵.۲ یا بالاتر نیاز دارد.
#
حذف یک گروه پیکربندی قابل واگرد نیست و همچنین تمام تنظیمات این گروه را برای همیشه حذف می کند. با این حال، بر برنامههای آزمایشی بسته/اجراها یا برنامههای آزمایشی/اجرای فعال تأثیری نمیگذارد مگر اینکه بهروزرسانی شوند.
یک گروه پیکربندی موجود و تنظیمات آن را حذف می کند.
POST index.php?/api/v2/delete_config_group/{config_group_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| config_group_id | عدد صحیح | درست است | شناسه گروه پیکربندی |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (گروه پیکربندی و تمام تنظیمات آن حذف شد) |
| 400 | گروه پیکربندی نامعتبر یا ناشناخته |
| 403 | بدون مجوز برای حذف گروه های پیکربندی یا عدم دسترسی به پروژه |
| 429 |
فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
delete_config #
#
این نقطه پایانی به TestRail ۵.۲ یا بالاتر نیاز دارد.
#
حذف یک گروه پیکربندی قابل واگرد نیست و همچنین تمام تنظیمات این گروه را برای همیشه حذف می کند. با این حال، بر برنامههای آزمایشی بسته/اجراها یا برنامههای آزمایشی/اجرای فعال تأثیری نمیگذارد مگر اینکه بهروزرسانی شوند.
یک پیکربندی موجود را حذف می کند.
POST index.php?/api/v2/delete_config/{config_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| config_id | عدد صحیح | درست است | شناسه پیکربندی |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | با موفقیت (پیکربندی حذف شد) |
| 400 | پیکربندی نامعتبر یا ناشناخته |
| 403 | بدون مجوز برای حذف تنظیمات یا عدم دسترسی به پروژه |
| 429 |
فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |

