از موارد زیر استفاده کنید API روشهایی برای درخواست جزئیات در تستکیسها (نمونههایی از تستکیسها اضافه شده به برنامههای آزمایشی خاص یا برنامههای آزمایشی).
get_test #
یک آزمایش موجود را برمی گرداند.
GET index.php?/api/v2/get_test/{test_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| test_id | عدد صحیح | درست است | شناسه آزمون |
اگر به آزمون علاقه مند هستید نتایج به جای تست ها، لطفا ببینید دریافت_نتایج در عوض
درخواست فیلتر #
فیلترهای زیر را می توان با استفاده از پارامترهای پرس و جو در URL درخواست اعمال کرد:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| with_data | رشته | پارامتر دریافت داده |
محتوای پاسخگویی #
پاسخ نمونه:
{
"assignedto_id": 1,
"case_id": 1,
"custom_expected": "..",
"custom_preconds": "..",
"custom_steps_separated": [
{
"content": "Step 1",
"expected": "Expected Result 1"
},
{
"content": "Step 2",
"expected": "Expected Result 2"
}
],
"estimate": "1m 5s",
"estimate_forecast": null,
"id": 100,
"priority_id": 2,
"run_id": 1,
"status_id": 5,
"title": "Verify line spacing on multi-page document",
"type_id": 4,
"labels": [
{
"id": 1,
"title": "label1",
},
{
"id": 2,
"title": "label2",
}
]
}
فیلدهای سیستم زیر همیشه در پاسخ گنجانده شده است:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| assignedto_id | عدد صحیح | شناسه کاربری که تست به آن اختصاص داده شده است |
| case_id | عدد صحیح | شناسه پرونده آزمایشی مربوطه |
| برآورد | بازه زمانی | برآورد تستکیس مرتبط، به عنوان مثال. «30s» یا «1m 45s» |
| تخمین_پیش بینی | بازه زمانی | پیشبینی تخمینی تستکیس مرتبط، به عنوان مثال. «30s» یا «1m 45s» |
| شناسه | عدد صحیح | شناسه منحصر به فرد آزمون |
| milestone_id | عدد صحیح | شناسه نقطه عطف که به پرونده آزمایشی مرتبط است |
| priority_id | عدد صحیح | شناسه اولویتی که به پرونده آزمایشی مرتبط است |
| مراجع | رشته | فهرستی از ارجاعات/شرایط جدا شده با کاما که به پرونده آزمایشی مرتبط هستند |
| run_id | عدد صحیح | شناسه آزمایشی که تست به آن تعلق دارد |
| status_id | عدد صحیح | شناسه وضعیت فعلی آزمون، get_statuses را نیز ببینید |
| عنوان | رشته | عنوان پرونده آزمایشی مرتبط |
| type_id | عدد صحیح | شناسه نوع تستکیس که به پرونده آزمایشی پیوند داده شده است |
فیلدهای سفارشی تستکیسها نیز در پاسخ گنجانده شده و از نام سیستم آنها با پیشوند “custom_” به عنوان شناسه فیلد خود استفاده می کنند. لطفا ببینید add_case برای لیست کامل انواع فیلدهای سفارشی موجود.
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (آزمون به عنوان بخشی از پاسخ برگردانده می شود) |
| 400 | تستکیس نامعتبر یا ناشناخته |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
get_tests #
فهرستی از آزمایشها را برای اجرای تست برمیگرداند.
GET index.php?/api/v2/get_tests/{run_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| run_id | عدد صحیح | درست است | شناسه اجرای تست |
اگر به آزمون علاقه مند هستید نتایج به جای تست ها، لطفا ببینید دریافت_نتایج در عوض
درخواست فیلتر #
فیلترهای زیر را می توان با استفاده از پارامترهای پرس و جو در URL درخواست اعمال کرد:
| نام | تایپ کنید | توضیحات |
|---|---|---|
| status_id | عدد صحیح (فهرست) | فهرستی از شناسههای وضعیت جدا شده با کاما برای فیلتر کردن |
| محدود کردن | عدد صحیح | عددی که محدودیت آزمایشها را برای نمایش در پاسخ تعیین میکند (پارامتر اختیاری. حد اندازه پاسخ به طور پیشفرض ۲۵۰ است) – به TestRail ۶.۷ یا بالاتر نیاز دارد. |
| جبران | عدد صحیح (فهرست) | عددی که موقعیتی را تعیین می کند که پاسخ باید از آن شروع شود (پارامتر اختیاری) – به TestRail ۶.۷ یا بالاتر نیاز دارد. |
|
label_id
|
عدد صحیح (فهرست) | شناسه برچسبها بهعنوان مقادیر جداشده با کاما برای فیلتر کردن. |
# All test cases for test run with ID 1 and status 4, 5 (Retest and Failed)
GET index.php?/api/v2/get_tests/1&offset=1&limit=30&status_id=4,5
{
"offset": 0,
"limit": 250,
"size": 236,
"_links": {
"next": null,
"prev": null,
},
"tests": [
{
"id": 1,
"title": "Test conditional formatting with basic value range",
},
{
"id": 2,
"title": "Verify line spacing on multi-page document",
},
]
}
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (آزمون ها به عنوان بخشی از پاسخ برگردانده می شوند) |
| 400 | اجرای تست نامعتبر یا ناشناخته |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
update_test #
برچسب های اختصاص داده شده به یک آزمایش موجود را به روز می کند.
POST index.php?/api/v2/update_test/{test_id}
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| test_id | عدد صحیح | درست است | شناسه آزمون به روز می شود. |
|
برچسب ها
|
آرایه ای از مقادیر مختلط (عدد صحیح یا رشته) | درست است | شناسه یک برچسب، عنوان یک برچسب یا هر دو، به شکل آرایه. |
محتوای پاسخ #
پاسخ نمونه:
{
"assignedto_id": 1,
"case_id": 1,
"custom_expected": "..",
"custom_preconds": "..",
"custom_steps_separated": [
{
"content": "Step 1",
"expected": "Expected Result 1"
},
{
"content": "Step 2",
"expected": "Expected Result 2"
}
],
"estimate": "1m 5s",
"estimate_forecast": null,
"id": 100,
"priority_id": 2,
"run_id": 1, "status_id": 5,
"title": "Verify line spacing on multi-page document",
"type_id": 4,
"labels": [
{
"id": 1,
"title": "label1",
},
{
"id": 2,
"title": "label2",
}
]
}
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (آزمون ها به عنوان بخشی از پاسخ برگردانده می شوند) |
| 400 | برچسب نامعتبر است |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
update_tests #
برچسب های اختصاص داده شده به چندین آزمایش را با مقادیر یکسان به روز می کند. این از بهروزرسانی چندین آزمایش با برچسبهای مختلف در هر آزمون پشتیبانی نمیکند.
POST index.php?/api/v2/update_tests
پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| test_id | عدد صحیح | درست است | شناسه آزمون به روز می شود. |
|
برچسب ها
|
آرایه ای از مقادیر مختلط (عدد صحیح یا رشته) | درست است | شناسه یک برچسب، عنوان یک برچسب یا هر دو، به شکل آرایه. |
محتوای پاسخ #
پاسخ نمونه:
{
"test_ids": [1, 2, 3],
"labels": [
{
"id": 1,
"title": "label1",
},
{
"id": 2,
"title": "label2",
}
]
}
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت (آزمون ها به عنوان بخشی از پاسخ برگردانده می شوند) |
| 400 | برچسب نامعتبر است |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |

