از موارد زیر استفاده کنید API روش هایی برای درخواست جزئیات در مورد پروژه ها و ایجاد یا اصلاح پروژه ها.
دریافت_پروژه #
یک پروژه موجود را برمی گرداند.
GET index.php?/api/v2/get_project/{project_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پروژه_id | عدد صحیح | درست است | شناسه پروژه |
محتوای پاسخگویی #
لطفاً مثال زیر را برای یک پاسخ معمولی ببینید:
{
"id": 1,
"announcement": "Welcome to project X",
"completed_on": 1389968184,
"default_role_id": 3,
"default_role": "Tester",
"is_completed": false,
"name": "Project X",
"show_announcement": true,
"suite_mode": 1,
"url": "https://instance.testrail.io/index.php?/projects/overview/1",
"users": [
{
"id": 3,
"global_role_id": null,
"global_role": null,
"project_role_id": null,
"project_role": null
}
],
"groups": []
}
فیلدهای زیر در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| اعلامیه | رشته | شرح / اطلاعیه پروژه |
| تکمیل_روشن | عدد صحیح | تاریخ/زمانی که پروژه به عنوان تکمیل شده علامت گذاری شد (به عنوان مهر زمانی یونیکس) |
| پیش فرض_نقش | رشته | نام نقش پیشفرض پیکربندی شده برای دسترسی به پروژه به TestRail ۷.۳ یا بالاتر نیاز دارد |
| default_role_id | عدد صحیح | شناسه نقش پیشفرض پیکربندی شده برای دسترسی به پروژه به TestRail ۷.۳ یا بالاتر نیاز دارد |
| گروه ها | آرایه | آرایه ای از اشیاء گروهی جدول گروه های زیر را ببینید- به TestRail ۷.۳ یا بالاتر نیاز دارد |
| شناسه | عدد صحیح | شناسه منحصر به فرد پروژه |
| is_completed | بولی | درست است اگر پروژه به عنوان تکمیل شده و در غیر این صورت نادرست علامت گذاری شود |
| نام | رشته | نام پروژه |
| نمایش_اعلان | بولی | درست برای نشان دادن اعلام/توضیحات و در غیر این صورت نادرست است |
| suite_mode | عدد صحیح | حالت مجموعه پروژه (۱ برای حالت یک سوئیت، ۲ برای مجموعه یک نفره + خطوط پایه، ۳ برای چندین سوئیت) |
| آدرس اینترنتی | رشته | آدرس/URL پروژه در رابط کاربری |
| کاربران | آرایه | آرایه ای از اشیاء کاربر. جدول کاربران را در زیر ببینید – به TestRail Enterprise ۷.۳ یا بالاتر نیاز دارد |
فیلدهای GROUPS زیر در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| شناسه | عدد صحیح | شناسه گروه کاربری |
| نقش | رشته | نام نقشی که در پروژه به گروه اختصاص داده شده است |
| role_id | عدد صحیح | شناسه نقش اختصاص داده شده به گروه در پروژه |
فیلدهای USERS زیر در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| شناسه | عدد صحیح | شناسه کاربر |
| global_role_id | عدد صحیح | شناسه نقش اختصاص داده شده به نمایه جهانی کاربر |
| نقش_جهانی | رشته | نام نقشی که به نمایه جهانی کاربر اختصاص داده شده است |
| project_role_id | عدد صحیح | شناسه نقشی که در پروژه به کاربر اختصاص داده شده است، در صورت وجود |
| پروژه_نقش | رشته | نام نقشی که در پروژه به کاربر اختصاص داده شده است، در صورت وجود |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (پروژه به عنوان بخشی از پاسخ بازگردانده می شود) |
| 400 | پروژه نامعتبر یا ناشناخته |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
دریافت_پروژه ها #
لیست پروژه های موجود را برمی گرداند.
GET index.php?/api/v2/get_projects
درخواست بدن #
فیلترهای زیر را می توان به عنوان پارامترهای پرس و جو در URL درخواست اعمال کرد:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| is_completed | بولی | ۱ فقط برای بازگرداندن پروژه های تکمیل شده. ۰ فقط برای بازگرداندن پروژه های فعال |
| محدود کردن | عدد صحیح | تعداد پروژه هایی که پاسخ باید برگرداند (اندازه پاسخ به طور پیش فرض ۲۵۰ است) – به TestRail ۶.۷ یا بالاتر نیاز دارد |
| جبران | عدد صحیح | شمارش پروژه ها را از کجا شروع کنیم (افست)- به TestRail ۶.۷ یا بالاتر نیاز دارد |
# All active projects
GET index.php?/api/v2/get_projects&is_completed=0
محتوای پاسخ #
پاسخ شامل مجموعه ای از پروژه ها است. هر پروژه در این لیست از همان قالب پیروی می کند دریافت_پروژه.
{
"offset": 0,
"limit": 250,
"size": 2,
"_links": {
"next": null,
"prev": null,
},
"projects": [
{ "id": 1, "name": "DataHub", .. },
{ "id": 2, "name": "Writer", .. }
]
}
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (پروژه ها به عنوان بخشی از پاسخ بازگردانده می شوند. توجه: فقط پروژه هایی را با حداقل دسترسی خواندن برمی گرداند.) |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
add_project #
یک پروژه جدید ایجاد می کند (وضعیت مدیر الزامی است).
POST index.php?/api/v2/add_project
درخواست بدن #
فیلترهای زیر را می توان در پیام بدن درخواست POST اعمال کرد:
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| نام | رشته | درست است | نام پروژه |
| اعلامیه | رشته | نادرست | شرح / اطلاعیه پروژه |
| نمایش_اعلان | بولی | نادرست | اگر اعلامیه باید در صفحه نمای کلی پروژه نمایش داده شود درست است و در غیر این صورت نادرست است |
| suite_mode | عدد صحیح | نادرست | حالت مجموعه پروژه (۱ برای حالت یک سوئیت، ۲ برای مجموعه یک نفره + خطوط پایه، ۳ برای چندین سوئیت) |
درخواست نمونه #
همچنین برای مثالی در مورد نحوه ایجاد یک پروژه جدید و خالی به زیر مراجعه کنید:
{
"name": "Project X",
"announcement": "Welcome to project X",
"show_announcement": true
}
محتوای پاسخگویی #
در صورت موفقیت آمیز بودن، این روش پروژه جدید را با استفاده از همان قالب پاسخ باز می گرداند دریافت_پروژه.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (پروژه ایجاد شد و به عنوان بخشی از پاسخ بازگردانده شد) |
| 403 | بدون مجوز برای افزودن پروژه ها (نیاز به حقوق مدیر است) |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
update_project #
یک پروژه موجود را بهروزرسانی میکند (وضعیت سرپرست الزامی است؛ بهروزرسانیهای جزئی پشتیبانی میشوند، یعنی فقط میتوانید فیلدهای خاص را ارسال و بهروزرسانی کنید).
POST index.php?/api/v2/update_project/{project_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پروژه_id | عدد صحیح | درست است | شناسه پروژه |
درخواست بدن #
فیلترهای زیر را می توان اعمال کرد:
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| نام | رشته | درست است | نام پروژه |
| اعلامیه | رشته | نادرست | شرح / اطلاعیه پروژه |
| نمایش_اعلان | بولی | نادرست | اگر اعلامیه باید در صفحه نمای کلی پروژه نمایش داده شود درست است و در غیر این صورت نادرست است |
| suite_mode | عدد صحیح | نادرست | حالت مجموعه پروژه (۱ برای حالت یک سوئیت، ۲ برای مجموعه یک نفره + خطوط پایه، ۳ برای چندین سوئیت) |
درخواست نمونه #
همچنین، برای مثالی از نحوه علامت گذاری پروژه به عنوان تکمیل شده، زیر را ببینید:
{
"announcement": "Happy Holidays Everyone!"
}
محتوای پاسخگویی #
{
"name": "Project X",
"announcement": "Welcome to project X",
"show_announcement": true,
"default_role_id": 3,
"is_completed": false,
"users": [
{
"user_id": 4,
"role_id": null
}
]
"groups": []
}
فیلدهای زیر در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| default_role_id | عدد صحیح | شناسه نقش پیشفرض پیکربندی شده برای دسترسی به پروژه به TestRail ۷.۳ یا بالاتر نیاز دارد |
| گروه ها | آرایه | آرایه ای از اشیاء گروهی جدول گروه های زیر را ببینید – به TestRail ۷.۳ یا بالاتر نیاز دارد |
| کاربران | آرایه | آرایه ای از اشیاء کاربر. جدول کاربران را در زیر ببینید.— به TestRail ۷.۳ یا بالاتر نیاز دارد |
فیلدهای GROUPS زیر در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| شناسه | عدد صحیح | شناسه گروه کاربری |
| role_id | عدد صحیح | شناسه نقش اختصاص داده شده به گروه در پروژه. برای تغییر تکلیف به “نقش جهانی” عدد ۰ را ارسال کنید. برای پاک کردن نقش خاص پروژه، null را ارسال کنید. |
فیلدهای USERS زیر در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| شناسه | عدد صحیح | شناسه کاربر |
| role_id | عدد صحیح | شناسه نقشی که در پروژه به کاربر اختصاص داده شده است. برای تغییر تکلیف به “نقش جهانی” عدد ۰ را ارسال کنید. برای پاک کردن انتساب نقش خاص پروژه، null را ارسال کنید |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (پروژه به روز شد و به عنوان بخشی از پاسخ بازگردانده شد) |
| 400 | پروژه نامعتبر یا ناشناخته |
| 403 | هیچ مجوزی برای تغییر پروژه ها وجود ندارد (نیاز به حقوق مدیر است) |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
POST index.php?/api/v2/delete_project/{project_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پروژه_id | عدد صحیح | درست است | شناسه پروژه |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (پروژه حذف شد) |
| 400 | پروژه نامعتبر یا ناشناخته |
| 403 |
بدون مجوز برای حذف پروژه ها (نیاز به حقوق مدیر) |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |

