از روش های API زیر برای درخواست جزئیات درباره گروه ها استفاده کنید.
#
نقاط پایانی گروهها فقط در TestRail ۷.۵ یا بالاتر در دسترس هستند.
get_group #
یک گروه موجود را برمی گرداند.
GET index.php?/api/v2/get_group/{group_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| group_id | عدد صحیح | درست است | شناسه گروه |
محتوای پاسخگویی #
{
"id": 1,
"name": "New group",
"user_ids": [1, 2, 3, 4, 5]
}
فیلدهای زیر در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| شناسه | عدد صحیح | شناسه منحصر به فرد گروه |
| نام | رشته | نام گروه |
| user_ids | آرایه | مجموعه ای از شناسه های کاربری هر شناسه یک کاربر متعلق به این گروه است |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (گروه بازیابی شد) |
| 400 |
پارامتر group_id نامعتبر است |
get_groups #
لیست گروه های موجود را برمی گرداند.
GET index.php?/api/v2/get_groups
محتوای پاسخگویی #
{
"offset": 0,
"limit": 250,
"size": 0,
"_links": {
"next": null,
"prev": null,
},
"groups": [
{
"id": 1,
"name": "New group",
"user_ids": [1, 2, 3, 4, 5]
}
]
}
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (گروه ها بازیابی شدند) |
add_group #
یک گروه جدید ایجاد می کند.
POST index.php?/api/v2/add_group
درخواست نمونه #
همچنین برای مثالی از نحوه ایجاد یک گروه جدید، به زیر مراجعه کنید
{
"name": "New Group",
"user_ids": [1, 2, 3, 4, 5]
}
فیلدهای زیر در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| نام | رشته | نام گروه |
| user_ids | آرایه | مجموعه ای از شناسه های کاربری هر شناسه یک کاربر متعلق به این گروه است |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (گروه ایجاد شد) |
| 400 |
مقدار فیلد نامعتبر، مانند شناسه نامعتبر در آرایه user_ids |
| 403 |
هیچ مجوزی برای ایجاد گروه های کاربری وجود ندارد |
update_group #
یک گروه موجود را به روز می کند.
POST index.php?/api/v2/update_group/{group_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| group_id | عدد صحیح | درست است | شناسه گروه |
این نقطه پایانی همان فیلدها را پشتیبانی می کند add_group.
#
با استفاده از update_group اعضای گروه را طوری تنظیم می کند که با آرایه user_ids ارائه شده مطابقت داشته باشند. امکان افزودن یا حذف کاربران وجود ندارد. آرایه user_ids ارسال شده باید همیشه لیست کامل کاربران گروه باشد.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | با موفقیت (گروه به روز شد) |
| 400 |
مقدار فیلد نامعتبر، مانند شناسه نامعتبر در آرایه user_ids |
| 403 |
هیچ مجوزی برای ویرایش گروه های کاربری وجود ندارد |
delete_group #
یک گروه موجود را حذف می کند.
POST index.php?/api/v2/delete_group/{group_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| group_id | عدد صحیح | درست است | شناسه گروه |
محتوای پاسخگویی #
این نقطه پایانی هیچ داده گروهی را بر نمی گرداند.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | با موفقیت (گروه حذف شد) |
| 400 | group_id نامعتبر است |
| 403 | هیچ مجوزی برای حذف گروه های کاربری وجود ندارد |

