از متدهای زیر API برای دریافت جزئیات configurationهای test plan و ایجاد یا تغییر configurationهایی استفاده کنید که برای ساخت test plan به کار می‌روند.
get_configs
فهرست configurationهای موجود را برمی‌گرداند که بر اساس گروه‌های configuration دسته‌بندی شده‌اند.
GET index.php?/api/v2/get_configs/{project_id}پارامترها
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| project_id | عدد صحیح | true | ID پروژه |
محتوای پاسخ
پاسخ شامل آرایه‌ای از گروه‌های configuration است که هرکدام فهرستی از configurationها را دارند. نمونه رایج را در ادامه ببینید:
[
{
"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
}
]
}
]
پاسخ نمونه، چند گروه configuration مربوط به مرورگرهای مختلف را نشان می‌دهد:
| ID | Configuration |
|---|---|
| 1 | Internet Explorer 10 |
| 2 | Internet Explorer 11 |
| 3 | Chrome |
| 4 | Firefox |
| 5 | Safari |
همچنین ببینید add_plan_entry و add_plan برای نمونه‌ای از نحوه استفاده از configurationها.
کدهای پاسخ
| Status Code | توضیحات |
|---|---|
| 200 | موفقیت‌آمیز (configurationها در پاسخ برگردانده می‌شوند) |
| 400 | پروژه نامعتبر یا ناشناخته است |
| 403 | به پروژه دسترسی ندارید |
| 429 |
فقط TestRail Cloud—درخواست‌ها بیش از حد مجاز است (ببینید API rate limit) |
add_config_group
این endpoint به TestRail ۵.۲ یا نسخه‌های بعدی نیاز دارد.
یک گروه configuration جدید ایجاد می‌کند.
POST index.php?/api/v2/add_config_group/{project_id}پارامترها
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| project_id | عدد صحیح | true | ID پروژه‌ای که گروه configuration باید به آن اضافه شود |
بدنه درخواست
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| name | رشته | true | نام گروه configuration |
نمونه درخواست
نمونه زیر نشان می‌دهد چطور یک گروه configuration جدید ایجاد کنید:
{
"name": "Browsers"
}کدهای پاسخ
| Status Code | توضیحات |
|---|---|
| 200 | موفقیت‌آمیز (گروه configuration ایجاد شد و در پاسخ برگردانده می‌شود) |
| 400 | پروژه نامعتبر یا ناشناخته است |
| 403 | مجوز افزودن گروه‌های configuration را ندارید یا به پروژه دسترسی ندارید |
| 429 |
فقط TestRail Cloud—درخواست‌ها بیش از حد مجاز است (ببینید API rate limit) |
add_config
این endpoint به TestRail ۵.۲ یا نسخه‌های بعدی نیاز دارد.
یک configuration جدید ایجاد می‌کند.
POST index.php?/api/v2/add_config/{config_group_id}پارامترها
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| config_group_id | عدد صحیح | true | ID گروه configuration که configuration باید به آن اضافه شود |
بدنه درخواست
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| name | رشته | true | نام configuration |
نمونه درخواست
نمونه زیر نشان می‌دهد چطور یک configuration جدید ایجاد کنید:
{
"name": "Chrome"
}کدهای پاسخ
| Status Code | توضیحات |
|---|---|
| 200 | موفقیت‌آمیز (گروه configuration ایجاد شد و در پاسخ برگردانده می‌شود) |
| 400 | پروژه نامعتبر یا ناشناخته است |
| 403 | مجوز افزودن configuration را ندارید یا به پروژه دسترسی ندارید |
| 429 |
فقط TestRail Cloud—درخواست‌ها بیش از حد مجاز است (ببینید API rate limit) |
update_config_group
این endpoint به TestRail ۵.۲ یا نسخه‌های بعدی نیاز دارد.
یک گروه configuration موجود را به‌روزرسانی می‌کند.
POST index.php?/api/v2/update_config_group/{config_group_id}پارامترها
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| config_group_id | عدد صحیح | true | ID گروه configuration |
بدنه درخواست
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| name | رشته | false | نام گروه configuration |
نمونه درخواست
نمونه زیر نشان می‌دهد چطور یک گروه configuration را به‌روزرسانی کنید:
{
"name": "Operating Systems"
}کدهای پاسخ
| Status Code | توضیحات |
|---|---|
| 200 | موفقیت‌آمیز (گروه configuration به‌روزرسانی شد و در پاسخ برگردانده می‌شود) |
| 400 | گروه configuration نامعتبر یا ناشناخته است |
| 403 | مجوز تغییر گروه‌های configuration را ندارید یا به پروژه دسترسی ندارید |
| 429 |
فقط TestRail Cloud—درخواست‌ها بیش از حد مجاز است (ببینید API rate limit) |
update_config
این endpoint به TestRail ۵.۲ یا نسخه‌های بعدی نیاز دارد.
یک configuration موجود را به‌روزرسانی می‌کند.
POST index.php?/api/v2/update_config/{config_id}پارامترها
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| config_id | عدد صحیح | true | ID configuration |
بدنه درخواست
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| name | رشته | false | نام configuration |
نمونه درخواست
نمونه زیر نشان می‌دهد چطور یک configuration را به‌روزرسانی کنید:
{
"name": "Firefox"
}کدهای پاسخ
| Status Code | توضیحات |
|---|---|
| 200 | موفقیت‌آمیز (configuration به‌روزرسانی شد و در پاسخ برگردانده می‌شود) |
| 400 | configuration نامعتبر یا ناشناخته است |
| 403 | مجوز تغییر configurationها را ندارید یا به پروژه دسترسی ندارید |
| 429 |
فقط TestRail Cloud—درخواست‌ها بیش از حد مجاز است (ببینید API rate limit) |
delete_config_group
این endpoint به TestRail ۵.۲ یا نسخه‌های بعدی نیاز دارد.
حذف یک گروه configuration قابل بازگشت نیست و همه configurationهای داخل آن گروه را برای همیشه حذف می‌کند. البته روی test planها یا test runهای بسته‌شده اثری ندارد و روی test planها یا test runهای فعال هم فقط زمانی اثر می‌گذارد که آن‌ها به‌روزرسانی شوند.
یک گروه configuration موجود و configurationهای آن را حذف می‌کند.
POST index.php?/api/v2/delete_config_group/{config_group_id}پارامترها
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| config_group_id | عدد صحیح | true | ID گروه configuration |
کدهای پاسخ
| Status Code | توضیحات |
|---|---|
| 200 | موفقیت‌آمیز (گروه configuration و همه configurationهای آن حذف شدند) |
| 400 | گروه configuration نامعتبر یا ناشناخته است |
| 403 | مجوز حذف گروه‌های configuration را ندارید یا به پروژه دسترسی ندارید |
| 429 |
فقط TestRail Cloud—درخواست‌ها بیش از حد مجاز است (ببینید API rate limit) |
delete_config
این endpoint به TestRail ۵.۲ یا نسخه‌های بعدی نیاز دارد.
حذف یک گروه configuration قابل بازگشت نیست و همه configurationهای داخل آن گروه را برای همیشه حذف می‌کند. البته روی test planها یا test runهای بسته‌شده اثری ندارد و روی test planها یا test runهای فعال هم فقط زمانی اثر می‌گذارد که آن‌ها به‌روزرسانی شوند.
یک configuration موجود را حذف می‌کند.
POST index.php?/api/v2/delete_config/{config_id}پارامترها
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| config_id | عدد صحیح | true | ID configuration |
کدهای پاسخ
| Status Code | توضیحات |
|---|---|
| 200 | موفقیت‌آمیز (configuration حذف شد) |
| 400 | configuration نامعتبر یا ناشناخته است |
| 403 | مجوز حذف configurationها را ندارید یا به پروژه دسترسی ندارید |
| 429 |
فقط TestRail Cloud—درخواست‌ها بیش از حد مجاز است (ببینید API rate limit) |