فیلدهای تستکیس
مدت زمان مطالعه: : 4 دقیقه
از موارد زیر استفاده کنید API روش هایی برای درخواست جزئیات در مورد فیلدهای سفارشی برای تستکیسها.
get_case_fields #
فهرستی از فیلدهای سفارشی تستکیس موجود را برمیگرداند.
GET index.php?/api/v2/get_case_fieldsمحتوای پاسخگویی #
پاسخ شامل مجموعه ای از تعاریف فیلد سفارشی است. لطفاً برای پاسخ معمولی زیر را ببینید:
[
{
"configs": [
{
"context": {
"is_global": true,
"project_ids": null
},
"id": "..",
"options": {
"default_value": "",
"format": "markdown",
"is_required": false,
"rows": "5"
}
}
],
"description": "The preconditions of this test case. ..",
"display_order": 1,
"id": 1,
"label": "Preconditions",
"name": "preconds",
"system_name": "custom_preconds",
"type_id": 3
},
..
]یک فیلد سفارشی میتواند تنظیمات و گزینههای مختلفی در هر پروژه داشته باشد که با علامت نشان داده میشود configs زمینه برای بررسی اینکه آیا یک فیلد سفارشی برای یک پروژه خاص قابل اجرا است (و برای یافتن گزینه های فیلد برای این پروژه)، context پیکربندی فیلد یا باید سراسری باشد (is_global) یا شناسه پروژه را در آن قرار دهید project_ids.
همچنین، لیست زیر انواع فیلدهای سفارشی موجود را نشان می دهد (type_id زمینه):
| شناسه را تایپ کنید | نام |
|---|---|
| 1 | رشته |
| 2 | عدد صحیح |
| 3 | متن |
| 4 | URL |
| 5 | چک باکس |
| 6 | کشویی |
| 7 | کاربر |
| 8 | تاریخ |
| 9 | نقطه عطف |
| 10 | مراحل |
| 12 | چند انتخابی |
کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (فیلدهای سفارشی موجود به عنوان بخشی از پاسخ بازگردانده می شوند) |
| 429 |
فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
add_case_field #
یک فیلد سفارشی تستکیس جدید ایجاد می کند.
POST index.php?/api/v2/add_case_fieldفیلدهای درخواست #
فیلدهای POST زیر پشتیبانی می شوند (فیلدهای سیستم):
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| نوع | رشته | درست است |
شناسه نوع برای فیلد سفارشی جدید. انواع زیر پشتیبانی می شوند:
شما می توانید شماره نوع و همچنین کلمه را ارسال کنید، به عنوان مثال. “۵”، “string”، “String”، “Dropdown”، “۱۲”. اعداد باید به صورت رشته ای ارسال شوند، به عنوان مثال {type: “۵”} نه {type: ۵}، در غیر این صورت، شما یک پاسخ ۴۰۰ (Bad Request) دریافت خواهید کرد. |
| نام | رشته | درست است | نام فیلد سفارشی جدید |
| برچسب | رشته | درست است | برچسب فیلد سفارشی جدید |
| توضیحات | رشته | نادرست | توضیحات مربوط به فیلد سفارشی جدید |
| شامل_همه | بولی | نادرست | اگر میخواهید فیلد سفارشی جدید برای همه الگوها گنجانده شود، پرچم را روی true تنظیم کنید. در غیر این صورت (نادرست) شناسه الگوها را به عنوان پارامتر بعدی (template_ids) درج کنید. |
| template_ids | آرایه | نادرست | اگر include_all روی false تنظیم شود، شناسههای قالبها، فیلد سفارشی جدید روی آن اعمال میشود |
| تنظیمات | شی | درست است | یک شی پیچیده شده در یک آرایه با دو کلید پیش فرض، “context” و “options” |
هنگام ایجاد فیلدهای سفارشی جدید، از نام های ساده بدون پیشوند “custom_” استفاده کنید زیرا به طور خودکار اضافه می شود. به عنوان مثال “my_int” با “custom_my_int” پیشوند خواهد شد.
فیلدهای سفارشی با تنظیمات به کلیدهای پیش فرض «context» و «options» نیاز دارند:
"configs": [
{
"context":{"is_global": true, "project_ids": []},
"options":{"is_required": false, "default_value": "1", "items": "1, First\n2, Second"}
}
]برای اعمال یک فیلد سفارشی برای پروژه های خاص، زمینه را تغییر دهید:
"context": {"is_global": false, "project_ids": [5, 10]}برخی از انواع فیلدهای سفارشی گزینه های مختلفی دارند. “is_required” (بولی) برای همه فیلدها مشترک است. اکثر انواع گزینه تنظیم “default_value” را دارند به استثنای انواع Multiselect، Milestone و Date که این گزینه مجاز نیست.
Dropdown و Text گزینه های خاصی دارند. برای کشویی موارد زیر است:
"items": "1, First\n2, Second"برای متن، از قالب و ردیف استفاده کنید:
"format": "plain", "rows": "5"برای “قالب” بین مقادیر “plain” یا “markdown” انتخاب کنید. گزینه “rows” اندازه اولیه فیلد را زمانی که کاربر یک فرم را بارگذاری می کند، مشخص می کند. مقادیر معتبر برای آن به عنوان مثال است. “۳”، “۴”، …، “۱۰” یا “” (رشته خالی).
"options": {
"is_required": false,
"default_value": "The default text.",
"format": "markdown",
"rows": "3"
}درخواست نمونه #
{
"type": "Multiselect",
"name": "my_multiselect",
"label": "My Multiselect",
"description": "my custom Multiselect description",
"configs": [
{
"context": {
"is_global": true,
"project_ids": ""
},
"options": {
"is_required": false,
"items": "1, One\n2, Two"
}
}
],
"include_all": true
}
محتوای پاسخگویی #
در صورت موفقیت آمیز بودن، این روش فیلد سفارشی جدید را برمی گرداند.
{
"id":33,
"name":"my_multiselect",
"system_name":"custom_my_multiselect",
"entity_id":1,
"label":"My Multiselect",
"description":"my custom Multiselect description",
"type_id":12,
"location_id":2,
"display_order":7,
"configs":"[{\"context\":{\"is_global\":true,\"project_ids\":\"\"},\"options\":{\"is_required\":false,\"items\":\"1, One\\n2, Two\"},\"id\":\"9f105ba2-1ed0-45e0-b459-18d890bad86e\"}]",
"is_multi":1,
"is_active":1,
"status_id":1,
"is_system":0,
"include_all":1,
"template_ids": []
}کدهای پاسخگویی #
| کد وضعیت | توضیحات |
|---|---|
| 200 | موفقیت آمیز (فیلد سفارشی جدید در پاسخ بازگردانده می شود) |
| 400 | درخواست بد، پیام خطا را برای تشخیص بررسی کنید |
| 404 | یافت نشد، پارامتر بد پاس شد |
| 429 |
فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API) |
