از متدهای API زیر برای دریافت جزئیات گروهها استفاده کنید.
#
endpointهای گروهها فقط در TestRail ۷.۵ یا نسخههای بعدی در دسترس هستند.
get_group #
یک گروه موجود را برمیگرداند.
GET index.php?/api/v2/get_group/{group_id}
پارامترها #
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| group_id | عدد صحیح | true | ID گروه |
محتوای پاسخ #
{
"id": 1,
"name": "New group",
"user_ids": [1, 2, 3, 4, 5]
}
فیلدهای زیر در پاسخ وجود دارند:
| نام | نوع | توضیحات |
|---|---|---|
| id | عدد صحیح | ID یکتای گروه |
| name | رشته | نام گروه |
| user_ids | آرایه | آرایهای از user IDها. هر ID کاربری است که عضو این گروه است |
کدهای پاسخ #
| Status Code | توضیحات |
|---|---|
| 200 | موفقیتآمیز (گروه دریافت شد) |
| 400 |
parameter 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]
}
]
}
کدهای پاسخ #
| Status Code | توضیحات |
|---|---|
| 200 | موفقیتآمیز (گروهها دریافت شدند) |
add_group #
یک گروه جدید ایجاد میکند.
POST index.php?/api/v2/add_group
نمونه درخواست #
نمونه زیر نشان میدهد چطور یک گروه جدید ایجاد کنید
{
"name": "New Group",
"user_ids": [1, 2, 3, 4, 5]
}
فیلدهای زیر در پاسخ وجود دارند:
| نام | نوع | توضیحات |
|---|---|---|
| name | رشته | نام گروه |
| user_ids | آرایه | آرایهای از user IDها. هر ID کاربری است که عضو این گروه است |
کدهای پاسخ #
| Status Code | توضیحات |
|---|---|
| 200 | موفقیتآمیز (گروه ایجاد شد) |
| 400 |
مقدار فیلد نامعتبر است؛ برای مثال ID نامعتبر در آرایه user_ids |
| 403 |
مجوز ایجاد گروههای کاربری را ندارید |
update_group #
یک گروه موجود را بهروزرسانی میکند.
POST index.php?/api/v2/update_group/{group_id}
پارامترها #
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| group_id | عدد صحیح | true | ID گروه |
این endpoint از همان فیلدهای add_group.
#
استفاده از update_group اعضای گروه را مطابق آرایه user_ids ارسالشده تنظیم میکند. امکان افزودن یا حذف جداگانه کاربران وجود ندارد. آرایه user_ids که ارسال میکنید باید همیشه فهرست کامل کاربران گروه باشد.
کدهای پاسخ #
| Status Code | توضیحات |
|---|---|
| 200 | موفقیتآمیز (گروه بهروزرسانی شد) |
| 400 |
مقدار فیلد نامعتبر است؛ برای مثال ID نامعتبر در آرایه user_ids |
| 403 |
مجوز ویرایش گروههای کاربری را ندارید |
delete_group #
یک گروه موجود را حذف میکند.
POST index.php?/api/v2/delete_group/{group_id}
پارامترها #
| نام | نوع | الزامی | توضیحات |
|---|---|---|---|
| group_id | عدد صحیح | true | ID گروه |
محتوای پاسخ #
این endpoint هیچ دادهای از گروه برنمیگرداند.
کدهای پاسخ #
| Status Code | توضیحات |
|---|---|
| 200 | موفقیتآمیز (گروه حذف شد) |
| 400 | group_id نامعتبر است |
| 403 | مجوز حذف گروههای کاربری را ندارید |

