طرح ها

از روش‌های API زیر برای درخواست جزئیات درباره طرح‌های آزمایشی و ایجاد یا تغییر طرح‌های آزمایشی استفاده کنید. در TestRail، برنامه‌های آزمایشی به شما این امکان را می‌دهند که چندین اجرای تست را با هم گروه‌بندی کنید و به‌طور خودکار اجرای تست را برای مرورگرها، سیستم‌عامل‌ها یا پیکربندی‌های دیگری که تنظیم کرده‌اید، بدون نیاز به اضافه کردن هر آزمایش به صورت جداگانه ایجاد کنید.

get_plan #

 یک طرح آزمایشی موجود را برمی‌گرداند.

GET index.php?/api/v2/get_plan/{plan_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
plan_id	عدد صحیح	درست است	شناسه طرح آزمون

محتوای پاسخگویی #

پاسخ نمونه:

{
    "id": 10,
    "name": "Release 1.0: Final (all browsers)",
    "description": null,
    "milestone_id": 3,
    "assignedto_id": null,
    "is_completed": false,
    "completed_on": null,
    "passed_count": 445,
    "blocked_count": 99,
    "untested_count": 473,
    "retest_count": 107,
    "failed_count": 56,
    "custom_status1_count": 0,
    "custom_status2_count": 0,
    "custom_status3_count": 0,
    "custom_status4_count": 0,
    "custom_status5_count": 0,
    "custom_status6_count": 0,
    "custom_status7_count": 0,
    "project_id": 1,
    "created_on": 1646058671,
    "created_by": 1,
    "url": "https://74trialapitesting.testrail.io/index.php?/plans/view/10",
    "start_on": null,
    "due_date": null,
    "entries": [
        {
            "id": "75698796-61d5-46e8-9c14-d334351f12d0",
            "suite_id": 1,
            "name": "Browser test",
            "refs": null,
            "description": null,
            "include_all": true,
            "runs": [
                {
                    "id": 13,
                    "suite_id": 1,
                    "name": "Browser test",
                    "description": null,
                    "milestone_id": 3,
                    "assignedto_id": null,
                    "include_all": true,
                    "is_completed": false,
                    "completed_on": null,
                    "passed_count": 88,
                    "blocked_count": 20,
                    "untested_count": 97,
                    "retest_count": 19,
                    "failed_count": 12,
                    "custom_status1_count": 0,
                    "custom_status2_count": 0,
                    "custom_status3_count": 0,
                    "custom_status4_count": 0,
                    "custom_status5_count": 0,
                    "custom_status6_count": 0,
                    "custom_status7_count": 0,
                    "project_id": 1,
                    "plan_id": 10,
                    "entry_index": 1,
                    "entry_id": "75698796-61d5-46e8-9c14-d334351f12d0",
                    "config": "Chrome",
                    "config_ids": [
                        3
                    ],
                    "created_on": 1646058671,
                    "refs": null,
                    "created_by": 1,
                    "url": "https://74trialapitesting.testrail.io/index.php?/runs/view/13"
                }
            ]
        }
    ]
}

فیلدهای زیر در پاسخ گنجانده شده است:

نام	تایپ کنید	توضیحات
assignedto_id	عدد صحیح	شناسه کاربری که کل طرح آزمایشی به آن اختصاص داده شده است
blocked_count	عدد صحیح	تعداد آزمایش‌ها در طرح آزمون به‌عنوان مسدود شده علامت‌گذاری شده است
تکمیل_روشن	مهر زمانی	تاریخ/زمان بسته شدن طرح آزمایشی (به عنوان مهر زمانی یونیکس)
ایجاد_توسط	عدد صحیح	شناسه کاربری که طرح آزمایشی را ایجاد کرده است
ایجاد_روشن	مهر زمانی	تاریخ/زمان ایجاد طرح آزمایشی (به عنوان مهر زمانی یونیکس)
سفارشی_وضعیت؟_count	عدد صحیح	تعداد تست ها در طرح تست با وضعیت سفارشی مربوطه
توضیحات	رشته	شرح طرح آزمون
ورودی ها	آرایه	آرایه‌ای از «ورودی‌ها»، یعنی گروهی از آزمایش‌ها
شکست_شمار	عدد صحیح	تعداد آزمون‌ها در طرح آزمون به‌عنوان ناموفق علامت‌گذاری شد
شناسه	عدد صحیح	شناسه منحصر به فرد طرح آزمون
is_completed	بولی	اگر طرح تست بسته بود درست است و در غیر این صورت نادرست
milestone_id	عدد صحیح	شناسه نقطه عطفی که این طرح آزمایشی به آن تعلق دارد
نام	رشته	نام طرح آزمون
گذشت_شمار	عدد صحیح	تعداد آزمون‌های طرح آزمون به‌عنوان قبولی علامت‌گذاری شده است
پروژه_id	عدد صحیح	شناسه پروژه ای که این طرح آزمایشی به آن تعلق دارد
مراجع	رشته	رشته ای از شناسه های نیازمندی خارجی که با کاما از هم جدا شده اند – به TestRail ۶.۳ یا بالاتر نیاز دارد
retest_count	عدد صحیح	تعداد آزمون‌ها در طرح آزمون به‌عنوان آزمون مجدد علامت‌گذاری شده است
تعداد_تست نشده	عدد صحیح	تعداد تست‌ها در طرح آزمون به‌عنوان تست نشده علامت‌گذاری شده است
آدرس اینترنتی	رشته	آدرس/URL طرح آزمایشی در رابط کاربری
start_on	مهر زمانی	تاریخ شروع یک طرح آزمایشی به عنوان مهر زمانی یونیکس.
به دلیل	مهر زمانی	تاریخ پایان یک طرح آزمایشی به عنوان مهر زمانی یونیکس.

را entries فیلد شامل آرایه ای از طرح آزمایشی است ورودی ها. ورودی طرح آزمایشی گروهی از اجراهای آزمایشی است که متعلق به یک مجموعه آزمایشی است (درست مانند رابط کاربری). هر گروه می تواند مقدار متغیری از اجرای تست داشته باشد و همچنین از تنظیمات پشتیبانی می کند. لطفا هم ببینید add_plan و add_plan_entry.

کدهای پاسخگویی #

کد وضعیت	توضیحات
200	موفقیت (طرح آزمایش و اجرای تست آن به عنوان بخشی از پاسخ برگردانده می شود)
400	طرح آزمایشی نامعتبر یا ناشناخته
403	عدم دسترسی به پروژه
429	فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

برنامه های دریافتی #

فهرستی از طرح های آزمایشی یک پروژه را برمی گرداند.

GET index.php?/api/v2/get_plans/{project_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
پروژه_id	عدد صحیح	درست است	شناسه پروژه

درخواست بدن #

نام	تایپ کنید	مورد نیاز	توضیحات
ایجاد_بعد	مهر زمانی	نادرست	فقط طرح های آزمایشی ایجاد شده پس از این تاریخ (به عنوان مهر زمانی یونیکس) را برگردانید
ایجاد شده_قبل	مهر زمانی	نادرست	فقط طرح های آزمایشی ایجاد شده قبل از این تاریخ را برگردانید (به عنوان مهر زمانی یونیکس)
ایجاد_توسط	عدد صحیح (فهرست)	نادرست	فهرستی از سازندگان (شناسه‌های کاربری) جدا شده با کاما برای فیلتر کردن
is_completed	بولی	نادرست	۱ فقط برای بازگرداندن طرح های آزمایشی تکمیل شده. ۰ فقط برای برگرداندن طرح های آزمایشی فعال
حد / جبران	عدد صحیح	نادرست	نتیجه را به :limit test plans محدود کنید. برای رد کردن رکوردها از :offset استفاده کنید
milestone_id	عدد صحیح (فهرست)	نادرست	فهرستی از شناسه‌های نقطه عطف جدا شده با کاما برای فیلتر کردن
مراجع	رشته	نادرست	شناسه مرجع (به عنوان مثال TR-a، ۴۲۹۱، و غیره)

این روش تا ۲۵۰ ورودی را در آرایه پاسخ برمی گرداند. برای بازیابی ورودی‌های اضافی، می‌توانید با استفاده از فیلتر افست که در بخش درخواست فیلترها در زیر توضیح داده شده است، درخواست‌های اضافی انجام دهید.

# All active test plans for project with ID 1 and milestone 2 or 3
GET index.php?/api/v2/get_plans/1&is_completed=0&milestone_id=2,3

محتوای پاسخ #

پاسخ شامل مجموعه ای از طرح های آزمایشی است. هر طرح آزمون در این لیست از همان قالب پیروی می کند get_plan، به جز برای ورودی ها فیلدی که در پاسخ گنجانده نشده است.

{
    "offset": 0,
    "limit": 250,
    "size": 1,
    "_links": {
        "next": null,
        "prev": null,
    },
    "plans": [
        {
            "id": 1,
            "name": "System test 1", 
            // ..
        },
        {
            "id": 2,
            "name": "System test 2", 
            // ..
        },
        // ..
    ]
}

get_plans نیز پشتیبانی می کند فیلترهای دینامیک:

{
    "id": 1,
    "name": "Test Plan Name",
    "entries": [
        {
            "id": "entry-id",
            "suite_id": 1,
            "name": "Test Run 1 Name",
            "include_all": false,
            "dynamic_filters": {
                "mode": "1",
                "filters": {
                    "cases:priority_id": {
                        "values": [2]
                    }
                }
            },
            "runs": [
                {
                    "id": 10,
                    "name": "Dynamic Filter Run",
                    "dynamic_filters": {
                        "mode": "1",
                        "filters": {
                            "cases:priority_id": {
                                "values": [2]
                            }
                        }
                    }
                }
            ]
        }
    ]
}

کدهای پاسخگویی #

کد وضعیت	توضیحات
200	موفقیت (طرح های آزمایشی به عنوان بخشی از پاسخ بازگردانده می شوند)
400	طرح آزمایشی نامعتبر یا ناشناخته
403	عدم دسترسی به پروژه
429	فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

add_plan #

یک طرح آزمایشی جدید ایجاد می کند.

POST index.php?/api/v2/add_plan/{project_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
پروژه_id	عدد صحیح	درست است	شناسه پروژه طرح آزمایش باید به آن اضافه شود

درخواست بدن #

نام	تایپ کنید	مورد نیاز	توضیحات
نام	رشته	درست است	نام طرح آزمون
توضیحات	رشته	نادرست	شرح طرح آزمون
milestone_id	عدد صحیح	نادرست	شناسه نقطه عطف برای پیوند به طرح آزمون
start_on	مهر زمانی	نادرست	تاریخ شروع یک طرح آزمایشی به عنوان مهر زمانی یونیکس.
به دلیل	مهر زمانی	نادرست	تاریخ شروع یک طرح آزمایشی به عنوان مهر زمانی یونیکس.
ورودی ها	آرایه	نادرست	آرایه ای از اشیاء که اجرای تست طرح را توصیف می کند، به مثال زیر و add_plan_entry مراجعه کنید.

درخواست نمونه #

 مثال زیر نحوه ایجاد یک طرح آزمایشی جدید با چندین اجرای تست را نشان می دهد:

{
    "name": "System test",
    "entries": [
        {
            "suite_id": 1,
            "name": "Custom run name",
            "assignedto_id": 1 // ID of the assignee
        },
        {
            "suite_id": 1,
            "include_all": false, // Custom selection
            "case_ids": [1, 2, 3, 5]
        }
    ]
}

add_plan نیز پشتیبانی می کند تنظیمات:

{
    "name": "System test",
    "entries": [
        {
            "suite_id": 1,
            "include_all": true,
            "config_ids": [1, 2, 4, 5, 6],
            "runs": [
                {
                    "include_all": false,
                    "case_ids": [1, 2, 3],
                    "assignedto_id": 1,
                    "config_ids": [2, 5]
                },
                {
                    "include_all": false,
                    "case_ids": [1, 2, 3, 5, 8],
                    "assignedto_id": 2,
                    "config_ids": [2, 6]
                }
                // ..
            ]
        },
        // ..
    ]
}

add_plan نیز پشتیبانی می کند فیلترهای دینامیک:

{
    "name": "Test Plan Name",
    "entries": [
        {
            "suite_id": 1,
            "name": "Dynamic Filter Entry",
            "include_all": false,
            "case_ids": [],
            "dynamic_filters": {
                "mode": "1",
                "filters": {
                    "cases:priority_id": {
                        "values": [2]
                    }
                }
            }
        }
    ]
}

این به طور موثر چندین بار آزمایشی را در هر ورودی طرح آزمایشی ایجاد می‌کند، مشابه نحوه مدیریت طرح‌ها و پیکربندی‌های آزمایشی با رابط کاربری TestRail. مراجعه فرمایید add_plan_entry در زیر برای جزئیات بیشتر

فیلد “refs” پشتیبانی می شود با TestRail ۶.۳ یا بالاتر.

محتوای پاسخگویی #

در صورت موفقیت آمیز بودن، این روش طرح آزمایشی جدید را با استفاده از همان قالب پاسخ بازمی گرداند get_plan.

کدهای پاسخگویی #

کد وضعیت	توضیحات
200	موفقیت آمیز (طرح آزمایش ایجاد شد و به عنوان بخشی از پاسخ برگردانده شد)
400	پروژه نامعتبر یا ناشناخته
403	بدون مجوز برای افزودن طرح های آزمایشی یا عدم دسترسی به پروژه
429	فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

add_plan_entry #

 یک یا چند آزمایش جدید را به طرح آزمایشی اضافه می کند.

POST index.php?/api/v2/add_plan_entry/{plan_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
plan_id	عدد صحیح	درست است	شناسه طرحی که آزمایش اجرا می شود باید به آن اضافه شود
فیلترهای_دینامیک	شی	نادرست	یک بار فیلتر پویا که برای انتخاب موارد موجود در اجرای تست استفاده می شود. محموله از همان رفتار فیلتر انتخاب رابط کاربری TestRail پیروی می کند.

درخواست بدن #

نام	تایپ کنید	مورد نیاز	توضیحات
suite_id	عدد صحیح	توضیحات را ببینید	شناسه مجموعه آزمایشی برای اجرای تست (در صورت استفاده از پروژه‌هایی با چند مجموعه یا پشتیبانی خط پایه ضروری است)
نام	رشته	نادرست	نام اجرای تست
توضیحات	رشته	نادرست	شرح طرح آزمون
assignedto_id	عدد صحیح	نادرست	۱ فقط برای بازگرداندن طرح های آزمایشی تکمیل شده. ۰ فقط برای برگرداندن طرح های آزمایشی فعال
start_on	مهر زمانی	نادرست	تاریخ شروع یک طرح آزمایشی به عنوان مهر زمانی یونیکس.
به دلیل	مهر زمانی	نادرست	تاریخ شروع یک طرح آزمایشی به عنوان مهر زمانی یونیکس.
شامل_همه	بولی	نادرست	نتیجه را به :limit test plans محدود کنید. برای رد کردن رکوردها از :offset استفاده کنید
case_ids	آرایه	نادرست	آرایه ای از شناسه های پرونده برای انتخاب مورد سفارشی (الزامی اگر include_all نادرست است)
config_ids	آرایه	نادرست	آرایه ای از شناسه های پیکربندی که برای اجرای تست ورودی طرح آزمایشی استفاده می شود
مراجع	رشته	نادرست	فهرستی از مراجع/شرایط جدا شده با کاما
اجرا می شود	آرایه	نادرست	آرایه ای از اجراهای آزمایشی

درخواست نمونه #

همچنین مثال زیر را ببینید که نحوه ایجاد یک ورودی طرح آزمایشی جدید با اجرای تست و پیکربندی های متعدد را نشان می دهد:

{
    "suite_id": 1,
    "assignedto_id": 1,                 // Default assignee
    "include_all": true,                // Default selection
    "config_ids": [1, 2, 4, 5, 6],
    "runs": [
        {
            "include_all": false,       // Override selection
            "case_ids": [1, 2, 3],
            "config_ids": [2, 5]
        },
        {
            "include_all": false,       // Override selection
            "case_ids": [1, 2, 3, 5, 8],
            "assignedto_id": 2,         // Override assignee
            "config_ids": [2, 6]
        },
        // ..
    ]
}

این به طور موثر اجرای تست جدیدی را برای هر عنصر آرایه ایجاد می کند runs زمینه سطح بالا assignedto_id، include_all و case_ids فیلدها انتخاب گیرنده پیش فرض و تست‌کیس را برای همه اجراهای آزمایشی مشخص می کنند. همانطور که در مثال بالا نشان داده شده است، می توانید این فیلدها را برای هر اجرای تست لغو کنید.

سطح بالا config_ids فیلد لیست ترکیبی از تنظیمات را برای لیست اجراهای آزمایشی مشخص می کند. تمام پیکربندی‌های ارجاع‌شده توسط آزمایش‌های جداگانه باید در این قسمت گنجانده شود. هر اجرای تست می‌تواند یک پیکربندی را برای هر گروه پیکربندی موجود مشخص کند و باید با یک ترکیب پیکربندی کامل مطابقت داشته باشد. به عنوان مثال، فرض کنید پیکربندی ها و گروه های پیکربندی زیر را داریم:

شناسه	گروه	پیکربندی
1	مرورگرها	کروم
2	مرورگرها	فایرفاکس
3	مرورگرها	اینترنت اکسپلورر
4	سیستم عامل ها	ویندوز ۷
5	سیستم عامل ها	ویندوز ۸
6	سیستم عامل ها	اوبونتو ۱۲

سطح بالا config_ids فیلد از مثال شامل تنظیمات است 1، 2، 4، 5 و 6. ترکیبات پیکربندی معتبر باید شامل یک پیکربندی از هر گروه پیکربندی باشد. بنابراین ترکیبات معتبر عبارتند از:

شناسه	ترکیبی
۱،۴	کروم، ویندوز ۷
1,5	کروم، ویندوز ۸
۱،۶	کروم، اوبونتو ۱۲
۲،۴	فایرفاکس، ویندوز ۷
۲،۵	فایرفاکس، ویندوز ۸
۲،۶	فایرفاکس، اوبونتو ۱۲

مثال انتخاب می کند که فقط دو مورد از این ترکیب ها را شامل شود 2,5 (فایرفاکس، ویندوز ۸) و 2,6 (فایرفاکس، اوبونتو ۱۲). TestRail به نوبه خود دو اجرای تست جداگانه را اضافه می کند، یکی برای هر ترکیب.

add_plan_entry نیز پشتیبانی می کند فیلترهای دینامیک:

{
  "id": "92ac304e-86e4-4b77-a27a-10d16f1141a2",
  "suite_id": 7660,
  "name": "Authentication Tests",
  "description": null,
  "refs": null,
  "include_all": false,
  "dynamic_filters": {
    "mode": "1",
    "filters": {
      "cases:section_id": {
        "values": [331183],
        "type_id": 4
      }
    }
  },
  "dataset_id": null,
  "runs": [
    {
      "id": 10116,
      "name": "Authentication Test Run 1",
      "description": null,
      "suite_id": 7660,
      "project_id": 400,
      "plan_id": 10115,
      "milestone_id": null,
      "assignedto_id": null,
      "include_all": false,
      "is_completed": false,
      "completed_on": null,
      "is_archived": false,
      "archived_on": null,
      "config": null,
      "config_ids": [],
      "passed_count": 0,
      "blocked_count": 0,
      "untested_count": 8,
      "retest_count": 0,
      "failed_count": 0,
      "created_by": 292,
      "created_on": 1781605370,
      "updated_on": null,
      "refs": null,
      "url": "https://test.testrail.io/index.php?/runs/view/123",
      "start_on": null,
      "due_on": null,
      "dynamic_filters": {
        "mode": "1",
        "filters": {
          "cases:section_id": {
            "values": [331183],
            "type_id": 4
          }
        }
      },
      "entry_index": 1,
      "entry_id": "92ac304e-86e4-4b77-a27a-10d16f1141a2",
      "custom_status1_count": 0,
      ...
      "dataset_id": null
    }
  ]
}

محتوای پاسخگویی #

در صورت موفقیت آمیز بودن، این روش ورودی طرح آزمایشی جدید شامل اجراهای آزمایشی را با استفاده از همان قالب پاسخ برمی گرداند entries زمینه از get_plan، اما برای یک ورودی به جای لیست ورودی ها.

کدهای پاسخگویی #

کد وضعیت	توضیحات
200	موفقیت آمیز بود (اجرای تست ایجاد شد و به عنوان بخشی از پاسخ برگردانده شد. لطفاً توجه داشته باشید که اجرای تست در یک طرح در «ورودی‌ها» سازمان‌دهی شده‌اند و اینها شناسه‌های خاص خود را دارند (به ترتیب با update_plan_entry و delete_plan_entry استفاده می‌شوند))
400	طرح آزمایشی نامعتبر یا ناشناخته
403	بدون مجوز برای تغییر طرح های آزمایشی یا عدم دسترسی به پروژه
429	فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

add_run_to_plan_entry #

POST index.php?/api/v2/add_run_to_plan_entry/{plan_id}/{entry_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
plan_id	عدد صحیح	درست است	شناسه طرحی که آزمایش اجرا می شود باید به آن اضافه شود
ورود_id	رشته	درست است	شناسه ورودی طرح آزمون
فیلترهای_دینامیک	شی	نادرست	یک بار فیلتر پویا که برای انتخاب موارد موجود در اجرای تست استفاده می شود. محموله از همان رفتار فیلتر انتخاب رابط کاربری TestRail پیروی می کند.

درخواست بدن #

نام	تایپ کنید	مورد نیاز	توضیحات
config_ids	آرایه	درست است	آرایه ای از شناسه های پیکربندی که برای اجرای تست ورودی طرح آزمایشی استفاده می شود
توضیحات	متن	نادرست	شرح اجرای تست
assignedto_id	عدد صحیح	نادرست	شناسه کاربری که اجرای تست باید به آن اختصاص داده شود
start_on	مهر زمانی	نادرست	تاریخ شروع یک طرح آزمایشی به عنوان مهر زمانی یونیکس.
به دلیل	مهر زمانی	نادرست	تاریخ شروع یک طرح آزمایشی به عنوان مهر زمانی یونیکس.
شامل_همه	بولی	نادرست	درست برای شامل همه تست‌کیس‌ها مجموعه آزمایشی و نادرست برای انتخاب مورد سفارشی
case_ids	آرایه	نادرست	آرایه ای از شناسه های پرونده برای انتخاب مورد سفارشی (الزامی اگر include_all نادرست است)
مراجع	رشته	نادرست	فهرستی از مراجع/شرایط جدا شده با کاما

درخواست نمونه #

همچنین، مثال زیر را ببینید که نشان می‌دهد چگونه یک آزمایش جدید را به ورودی طرح آزمایشی اضافه کنید:

{
    "config_ids": [1, 5],
    "include_all": false,
    "case_ids": [1, 2, 4]
}

add_run_to_plan_entry نیز پشتیبانی می کند فیلترهای دینامیک:

{
    "suite_id": 1,
    "name": "Test Plan Entry",
    "include_all": false,
    "case_ids": [],
    "dynamic_filters": {
        "mode": "1",
        "filters": {
            "cases:priority_id": {
                "values": [2]
            }
        }
    }
}

کدهای پاسخگویی #

کد وضعیت	توضیحات
200	موفقیت آمیز (اجرای تست به روز شد و به عنوان بخشی از پاسخ برگردانده شد)
400	طرح آزمایشی یا ورودی طرح نامعتبر یا ناشناخته، یا بدنه POST نامعتبر است
403	بدون مجوز برای تغییر طرح های آزمایشی یا عدم دسترسی به پروژه
429	فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

update_plan #

یک طرح آزمایشی موجود را به‌روزرسانی می‌کند (به‌روزرسانی‌های جزئی پشتیبانی می‌شوند، یعنی فقط می‌توانید فیلدهای خاص را ارسال و به‌روزرسانی کنید).

POST index.php?/api/v2/update_plan/{plan_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
plan_id	عدد صحیح	درست است	شناسه طرح آزمون

به استثنای ورودی ها فیلد، این روش از همان فیلدهای POST پشتیبانی می کند add_plan.

محتوای پاسخگویی #

در صورت موفقیت آمیز بودن، این روش طرح آزمایشی به روز شده را با استفاده از همان قالب پاسخ باز می گرداند get_plan.

کدهای پاسخگویی #

کد وضعیت	توضیحات
200	موفقیت آمیز (طرح آزمون به روز شد و به عنوان بخشی از پاسخ بازگردانده شد)
400	طرح آزمایشی نامعتبر یا ناشناخته
403	بدون مجوز برای تغییر طرح های آزمایشی یا عدم دسترسی به پروژه
429	فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

update_plan_entry #

یک یا چند گروه آزمایشی را در یک طرح به‌روزرسانی می‌کند (به‌روزرسانی‌های جزئی پشتیبانی می‌شوند، یعنی فقط می‌توانید فیلدهای خاصی را ارسال و به‌روزرسانی کنید).

POST index.php?/api/v2/update_plan_entry/{plan_id}/{entry_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
plan_id	عدد صحیح	درست است	شناسه طرح آزمون
ورود_id	رشته	درست است	شناسه ورودی طرح آزمایشی (توجه: نه شناسه اجرای تست)
فیلترهای_دینامیک	شی	نادرست	یک بار فیلتر پویا که برای انتخاب موارد موجود در اجرای تست استفاده می شود. محموله از همان رفتار فیلتر انتخاب رابط کاربری TestRail پیروی می کند.

درخواست بدن #

نام	تایپ کنید	مورد نیاز	توضیحات
نام	رشته	درست است	نام اجرای تست
توضیحات	متن	نادرست	شرح اجرای تست (های) – به TestRail ۵.۲ یا بالاتر نیاز دارد
assignedto_id	عدد صحیح	نادرست	شناسه کاربری که اجرای تست باید به آن اختصاص داده شود
start_on	مهر زمانی	نادرست	تاریخ شروع یک طرح آزمایشی به عنوان مهر زمانی یونیکس.
به دلیل	مهر زمانی	نادرست	تاریخ شروع یک طرح آزمایشی به عنوان مهر زمانی یونیکس.
شامل_همه	بولی	نادرست	درست برای شامل تمام تست‌کیس‌ها مجموعه آزمایشی و نادرست برای انتخاب مورد سفارشی (پیش‌فرض: درست)
case_ids	آرایه	نادرست	آرایه ای از شناسه های پرونده برای انتخاب مورد سفارشی (الزامی اگر include_all نادرست است)
مراجع	رشته	نادرست	رشته ای از شناسه های نیازمندی خارجی که با کاما از هم جدا شده اند. – به TestRail ۶.۳ یا بالاتر نیاز دارد

 

محتوای پاسخگویی #

در صورت موفقیت آمیز بودن، این روش ورودی طرح آزمایشی به روز شده شامل اجرای تست را با استفاده از همان قالب پاسخ باز می گرداند entries زمینه از get_plan، اما برای یک ورودی به جای لیست ورودی ها.

کدهای پاسخگویی #

کد وضعیت	توضیحات
200	موفقیت آمیز (اجرای تست به روز شد و به عنوان بخشی از پاسخ برگردانده شد)
400	طرح یا ورودی آزمون نامعتبر یا ناشناخته
403	بدون مجوز برای تغییر طرح های آزمایشی یا عدم دسترسی به پروژه
429	فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

update_run_in_plan_entry #

یک اجرا را در یک ورودی طرح که از تنظیمات استفاده می کند به روز می کند.

POST index.php?/api/v2/update_run_in_plan_entry/{run_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
run_id	عدد صحیح	درست است	شناسه اجرای تست
فیلترهای_دینامیک	شی	نادرست	یک بار فیلتر پویا که برای انتخاب موارد موجود در اجرای تست استفاده می شود. محموله از همان رفتار فیلتر انتخاب رابط کاربری TestRail پیروی می کند.

درخواست بدن #

نام	تایپ کنید	مورد نیاز	توضیحات
توضیحات	متن	نادرست	شرح اجرای تست
assignedto_id	عدد صحیح	نادرست	شناسه کاربری که اجرای تست باید به آن اختصاص داده شود
start_on	مهر زمانی	نادرست	تاریخ شروع یک طرح آزمایشی به عنوان مهر زمانی یونیکس.
به دلیل	مهر زمانی	نادرست	تاریخ شروع یک طرح آزمایشی به عنوان مهر زمانی یونیکس.
شامل_همه	بولی	نادرست	درست برای شامل تمام تست‌کیس‌ها مجموعه آزمایشی و نادرست برای انتخاب مورد سفارشی (پیش‌فرض: درست)
case_ids	آرایه	توضیحات را ببینید	آرایه ای از شناسه های پرونده برای انتخاب مورد سفارشی (الزامی اگر include_all نادرست است)
مراجع	رشته	نادرست	رشته ای از شناسه های نیازمندی خارجی که با کاما از هم جدا شده اند. – به TestRail ۶.۳ یا بالاتر نیاز دارد

درخواست نمونه #

همچنین، مثال زیر را ببینید که نشان می‌دهد چگونه یک اجرا را در داخل یک ورودی طرح که از تنظیمات استفاده می‌کند به‌روزرسانی کنید:

{
    "include_all": false,
    "case_ids": [1,2,4]
}

کدهای پاسخگویی #

کد وضعیت	توضیحات
200	موفقیت آمیز (اجرای تست به روز شد و به عنوان بخشی از پاسخ برگردانده شد)
400	اجرای تست نامعتبر یا ناشناخته یا بدنه POST نامعتبر
403	بدون مجوز برای تغییر طرح های آزمایشی یا عدم دسترسی به پروژه
429	فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

close_plan #

یک طرح آزمایشی موجود را می بندد و اجرای تست آن را بایگانی می کند & نتایج

POST index.php?/api/v2/close_plan/{plan_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
plan_id	عدد صحیح	درست است	شناسه طرح آزمون

محتوای پاسخگویی #

در صورت موفقیت آمیز بودن، این روش طرح تست بسته را با استفاده از همان قالب پاسخ باز می گرداند get_plan.

کدهای پاسخگویی #

کد وضعیت	توضیحات
200	موفقیت آمیز (طرح آزمایشی و تمام مراحل آزمایشی آن بسته شد (بایگانی شد). طرح آزمایشی و اجرای تست آن به عنوان بخشی از پاسخ برگردانده می‌شوند)
400	طرح آزمایشی نامعتبر یا ناشناخته
403	بدون مجوز برای بستن طرح های آزمایشی یا عدم دسترسی به پروژه
429	فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

delete_plan #

یک طرح آزمایشی موجود را حذف می کند.

POST index.php?/api/v2/delete_plan/{plan_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
plan_id	عدد صحیح	درست است	شناسه طرح آزمون

کدهای پاسخگویی #

کد وضعیت	توضیحات
200	موفقیت آمیز (طرح آزمایشی و تمام اجراهای آزمایشی آن حذف شد)
400	طرح آزمایشی نامعتبر یا ناشناخته
403	بدون مجوز برای حذف طرح های آزمایشی یا عدم دسترسی به پروژه
429	فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

delete_plan_entry #

یک یا چند اجرای تست موجود را از یک طرح حذف می کند.

POST index.php?/api/v2/delete_plan_entry/{plan_id}/{entry_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
plan_id	عدد صحیح	درست است	شناسه طرح آزمون
ورود_id	رشته	درست است	شناسه ورودی طرح آزمایشی (توجه: نه شناسه اجرای تست)

کدهای پاسخگویی #

کد وضعیت	توضیحات
200	موفقیت آمیز (اجرای تست از طرح آزمایشی حذف شد)
400	طرح یا ورودی آزمون نامعتبر یا ناشناخته
403	بدون مجوز برای حذف طرح های آزمایشی یا عدم دسترسی به پروژه
429	فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)

delete_run_from_plan_entry #

اجرای تست را از ورودی طرح آزمایشی حذف می کند

POST index.php?/api/v2/delete_run_from_plan_entry/{run_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
run_id	عدد صحیح	درست است	شناسه اجرای تست

کدهای پاسخگویی #

کد وضعیت	توضیحات
200	موفقیت آمیز (اجرای تست از طرح آزمایشی حذف شد)
400	طرح یا ورودی آزمون نامعتبر یا ناشناخته
403	بدون مجوز برای حذف طرح های آزمایشی یا عدم دسترسی به پروژه
429	فقط TestRail Cloud– درخواست های بسیار زیاد (نگاه کنید به محدودیت نرخ API)