فیلدهای فیلتر پویا
مدت زمان مطالعه: : 4 دقیقه
از روش API زیر برای درخواست لیست فیلدهای موجود برای فیلتر پویا هنگام ایجاد یا بهروزرسانی اجرای تست و طرحهای آزمایشی استفاده کنید.
get_dynamic_filter_fields #
لیست فیلدهای موجود برای فیلتر پویا برای یک پروژه خاص را برمی گرداند.
GET index.php?/api/v2/get_dynamic_filter_fields/{project_id}پارامترها #
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| پروژه_id | عدد صحیح | درست است | شناسه پروژه که فیلدهای فیلتر پویا باید برای آن برگردانده شوند. |
محتوای پاسخگویی #
پاسخ شامل مجموعه ای از تعاریف میدان است که می توان از آنها برای ساخت استفاده کرد dynamic_filters بارهای قابل پشتیبانی برای اجرای و برنامه ریزی نقاط پایانی API.
فیلدهای برگشتی با فیلدهای فیلتر پویا موجود در TestRail UI برای پروژه انتخابی مطابقت دارند. این شامل فیلدهای سیستم پشتیبانی شده و فیلدهای تستکیس سفارشی فعال است که برای پروژه قابل فیلتر هستند.
انواع فیلدهای غیر قابل فیلتر، مانند متن، مراحل و سناریوها، برگردانده نمی شوند. لطفاً برای پاسخ معمولی زیر را ببینید:
[
{
"type_id": 6,
"system_name": "status_id",
"label": "Status",
"options": "1, Untested\n2, Retest\n3, Passed\n4, Failed"
},
{
"type_id": 6,
"system_name": "priority_id",
"label": "Priority",
"options": "1, Low\n2, Medium\n3, High"
},
{
"type_id": 1,
"system_name": "title",
"label": "Title",
"sub_filters": "1, Is\n2, Is Not\n5, Contains\n6, Does not contain"
},
{
"type_id": 8,
"system_name": "updated_on",
"label": "Updated On",
"sub_filters": "1, Is\n2, Is Not\n3, Is Before\n4, Is After"
},
{
"type_id": 12,
"system_name": "custom_multiselect",
"label": "Custom Multiselect",
"options": "1, Option 1\n2, Option 2"
}
]فیلدهای پاسخ #
| نام | تایپ کنید | توضیحات |
|---|---|---|
| type_id | عدد صحیح | شناسه نوع فیلد مشتریان می توانند از این برای تعیین نحوه رندر یا ساخت فیلتر برای فیلد استفاده کنند. |
| system_name | رشته | نام سیستم فیلد. این مقدار در هنگام ساخت استفاده می شود dynamic_filters. |
| برچسب | رشته | برچسب نمایش فیلد. |
| گزینه ها | رشته | گزینه های موجود برای فیلدهایی با مقادیر قابل انتخاب، مانند کشویی، انتخاب چندگانه، کاربر، نقطه عطف، اولویت، وضعیت، نوع یا الگوها. |
| فیلترهای فرعی | رشته | عملگرهای پشتیبانی شده برای فیلدهایی که از فیلتر مبتنی بر شرایط پشتیبانی می کنند، مانند فیلدهای رشته، URL، عدد صحیح یا تاریخ. |
شناسه های نوع فیلد #
| شناسه را تایپ کنید | نام |
|---|---|
| 1 | رشته |
| 2 | عدد صحیح |
| 3 | متن |
| 4 | URL |
| 5 | چک باکس |
| 6 | کشویی |
| 7 | کاربر |
| 8 | تاریخ |
| 9 | نقطه عطف |
| 10 | مراحل |
| 12 | چند انتخابی |
فیلدهای پشتیبانی شده #
پاسخ می تواند شامل فیلدهای سیستم پشتیبانی شده باشد مانند:
| میدان | توضیحات |
|---|---|
| اختصاص داده شده به | موارد را توسط کاربر اختصاص داده شده فیلتر کنید. |
| نوع اتوماسیون | کیس ها را بر اساس نوع اتوماسیون فیلتر کنید. |
| ایجاد شده توسط | موارد را بر اساس سازنده فیلتر کنید. |
| ایجاد شد | موارد را بر اساس تاریخ ایجاد فیلتر کنید. |
| تخمین بزنید | موارد را بر اساس تخمین فیلتر کنید. |
| پیش بینی | موارد را بر اساس پیش بینی فیلتر کنید. |
| برچسب ها | موارد را بر اساس برچسب فیلتر کنید. |
| نقطه عطف | موارد را بر اساس نقطه عطف فیلتر کنید. |
| اولویت | موارد را بر اساس اولویت فیلتر کنید. |
| مراجع | موارد را با مراجع فیلتر کنید. |
| قالب ها | موارد را بر اساس الگو فیلتر کنید. |
| عنوان | موارد را بر اساس عنوان فیلتر کنید. |
| تایپ کنید | کیس ها را بر اساس نوع کیس فیلتر کنید. |
| به روز شده توسط | موارد را بر اساس آخرین کاربر به روز شده فیلتر کنید. |
| به روز شد | موارد را بر اساس آخرین تاریخ به روز رسانی فیلتر کنید. |
پاسخ همچنین میتواند شامل فیلدهای تستکیس سفارشی فعال باشد که برای پروژه انتخابی در دسترس هستند و توسط فیلتر پویا پشتیبانی میشوند.
استفاده از نام فیلدها در فیلترهای پویا #
هنگام استفاده از فیلدی که توسط این نقطه پایانی در a dynamic_filters محموله، پیشوند system_name با cases:.
برای مثال، اگر این نقطه پایانی برگردد:
{
"type_id": 6,
"system_name": "priority_id",
"label": "Priority",
"options": "1, Low\n2, Medium\n3, High"
}از فیلد به صورت زیر در یک فیلتر پویا استفاده کنید:
{
"mode": "1",
"filters": {
"cases:priority_id": {
"values": [2]
}
}
}کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت فیلدهای فیلتر پویا موجود به عنوان بخشی از پاسخ برگردانده می شوند. |
| 400 | پروژه نامعتبر یا ناشناخته |
| 403 | عدم دسترسی به پروژه |
| 429 | فقط TestRail Cloud – درخواستهای بسیار زیاد. |
یادداشت ها #
این نقطه پایانی فقط فیلدهای پشتیبانی شده توسط رفتار فیلتر پویا TestRail را برای پروژه انتخابی برمی گرداند. باید قبل از ساخت استفاده شود dynamic_filters بارهای پرداختی، به ویژه هنگام ساخت کلاینت های API، CLI یا ادغام هایی که نیاز به ارائه گزینه های فیلتر پویا در خارج از TestRail UI دارند.
استفاده از فیلترهای پویا با اجراها و پلان ها #
را get_dynamic_filter_fields نقطه پایانی برای کشف اینکه کدام فیلدها را می توان در a استفاده کرد استفاده می شود dynamic_filters محموله فیلترهای پویا هنگام ایجاد یا بهروزرسانی برنامههای آزمایشی و برنامههای آزمایشی پشتیبانی میشوند و به مشتریان API اجازه میدهند تا انتخابهایی ایجاد کنند که مانند رابط کاربری TestRail عمل کنند. فیلتر انتخاب.
