موارد

از موارد زیر استفاده کنید API روش‌هایی برای بازیابی داده‌های مربوط به تست‌کیس‌ها – مانند عنوان، فیلدهای تست‌کیس و سابقه – و ایجاد، اصلاح یا حذف تست‌کیس‌ها.

get_case #

یک تست‌کیس موجود را برمی‌گرداند.

GET index.php?/api/v2/get_case/{case_id}

پارامترها #

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

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

# Get the test case with an ID of 42
GET index.php?/api/v2/get_case/42

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

پاسخ نمونه:

{
    "id": 1,
    "title": "Print document history and attributes",
    "section_id": 1,
    "template_id": 1,
    "type_id": 2,
    "priority_id": 2,
    "milestone_id": null,
    "refs": null,
    "created_by": 1,
    "created_on": 1646317844,
    "updated_by": 1,
    "updated_on": 1646317844,
    "estimate": null,
    "estimate_forecast": "8m 40s",
    "suite_id": 1,
    "display_order": 1,
    "is_deleted": 0,
    "custom_automation_type": 0,
    "custom_preconds": null,
    "custom_steps": null,
    "custom_expected": null,
    "custom_steps_separated": null,
    "custom_mission": null,
    "custom_goals": null,
    "labels": [
     {
      "id": 1,
      "title": "label1",
      "created_by:"2",
      "created_on: "timestamp",
      },
     {
      "id": 2,
      "title": "label2",
      "created_by":"2",
      "created_on": "timestamp",
      }
    ]

}

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

نام	تایپ کنید	توضیحات
ایجاد_توسط	عدد صحیح	شناسه کاربری که تست‌کیس را ایجاد کرده است
ایجاد_روشن	مهر زمانی	تاریخ/زمانی که تست‌کیس ایجاد شد (به عنوان مهر زمانی یونیکس)
برآورد	بازه زمانی	برآورد، به عنوان مثال «30s» یا «1m 45s»
تخمین_پیش بینی	بازه زمانی	پیش بینی برآورد، به عنوان مثال «30s» یا «1m 45s»
شناسه	عدد صحیح	شناسه منحصر به فرد تست‌کیس
milestone_id	عدد صحیح	شناسه نقطه عطف که به پرونده آزمایشی مرتبط است
priority_id	عدد صحیح	شناسه اولویتی که به پرونده آزمایشی مرتبط است
مراجع	رشته	فهرستی از ارجاعات/شرایط جدا شده با کاما که به پرونده آزمایشی مرتبط هستند
section_id	عدد صحیح	شناسه بخشی که تست‌کیس به آن تعلق دارد
suite_id	عدد صحیح	شناسه مجموعه تست‌کیس متعلق به آن است
template_id	عدد صحیح	شناسه الگو (طرح فیلد) تست‌کیس مورد استفاده قرار می گیرد-به TestRail ۵.۲ یا بالاتر نیاز دارد
عنوان	رشته	عنوان پرونده آزمایشی
type_id	عدد صحیح	شناسه نوع تست‌کیس که به پرونده آزمایشی پیوند داده شده است
به روز شده_توسط	عدد صحیح	شناسه کاربری که آخرین بار تست‌کیس را به‌روزرسانی کرده است
updated_on	مهر زمانی	تاریخ/زمان آخرین به‌روزرسانی پرونده آزمایشی (به عنوان مهر زمانی یونیکس)

فیلدهای سفارشی نیز در پاسخ گنجانده شده اند و از نام سیستم خود با پیشوند “custom_” به عنوان شناسه فیلد خود استفاده می کنند. لطفا ببینید add_case برای لیست کامل انواع فیلدهای سفارشی موجود.

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

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

get_cases #

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

GET index.php?/api/v2/get_cases/{project_id}&suite_id={suite_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
پروژه_id	عدد صحیح	درست است	شناسه پروژه
suite_id	عدد صحیح	توضیحات را ببینید	شناسه مجموعه آزمایشی (در صورتی که پروژه در حالت تک مجموعه کار می کند اختیاری است)
ایجاد_بعد	مهر زمانی	نادرست	فقط تست‌کیس‌ها ایجاد شده پس از این تاریخ را برگردانید (به عنوان مهر زمانی یونیکس)
ایجاد شده_قبل	مهر زمانی	نادرست	فقط تست‌کیس‌ها ایجاد شده قبل از این تاریخ را برگردانید (به عنوان مهر زمانی یونیکس)
ایجاد_توسط	عدد صحیح (فهرست)	نادرست	فهرستی از سازندگان (شناسه‌های کاربری) جدا شده با کاما برای فیلتر کردن
فیلتر	رشته	نادرست	فقط موارد را با رشته فیلتر منطبق در عنوان حروف برگردانید
محدود کردن	عدد صحیح	نادرست	تعداد تست‌کیس‌ها که باید پاسخ داده شود (اندازه پاسخ به طور پیش فرض ۲۵۰ است) –به TestRail ۶.۷ یا بالاتر نیاز دارد
milestone_id	عدد صحیح (فهرست)	نادرست	فهرستی از شناسه‌های نقطه عطف جدا شده با کاما برای فیلتر کردن (اگر فیلد نقطه عطف برای پروژه غیرفعال باشد، در دسترس نیست)
جبران	عدد صحیح	نادرست	از کجا باید شمارش موارد آزمایش را شروع کرد (افست)-به TestRail ۶.۷ یا بالاتر نیاز دارد
priority_id	عدد صحیح (فهرست)	نادرست	فهرستی از شناسه‌های اولویت‌دار جدا شده با کاما برای فیلتر کردن
مراجع	رشته	نادرست	یک شناسه مرجع واحد (به عنوان مثال TR-۱، ۴۲۹۱، و غیره) –به TestRail ۶.۵.۲ یا بالاتر نیاز دارد
section_id	عدد صحیح	نادرست	شناسه بخش آزمایشی
template_id	عدد صحیح (فهرست)	نادرست	فهرستی از شناسه‌های قالب جدا شده با کاما برای فیلتر کردن بر اساس –به TestRail ۵.۲ یا بالاتر نیاز دارد
type_id	عدد صحیح (فهرست)	نادرست	فهرستی از شناسه‌های نوع حروف جدا شده با کاما برای فیلتر کردن
به روز شد_بعد	مهر زمانی	نادرست	فقط تست‌کیس‌ها را که پس از این تاریخ به روز شده اند برگردانید (به عنوان مهر زمانی یونیکس)
به روز شده_قبل	مهر زمانی	نادرست	فقط تست‌کیس‌ها را که قبل از این تاریخ به روز شده اند برگردانید (به عنوان مهر زمانی یونیکس)
به روز شده_توسط	عدد صحیح	نادرست	فهرستی از شناسه‌های کاربری جدا شده با کاما که تست‌کیس‌ها را برای فیلتر کردن به‌روزرسانی کرده‌اند
label_id	عدد صحیح (فهرست)	نادرست	فهرستی از شناسه‌های برچسب جدا شده با کاما برای فیلتر کردن

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

# Get all the test cases that are in project 34 (project ID of 34), suite with ID of 2 and priority 3 or 4
GET index.php?/api/v2/get_cases/34&suite_id=2&priority_id=3,4

# Get 10 test cases from project 34
GET index.php?/api/v2/get_cases/34&limit=10

# Only returning test cases from project 34 starting the offset number
GET index.php?/api/v2/get_cases/34&offset=5

# Filter cases in project 34 with a filter string of "login"
GET index.php?/api/v2/get_cases/34&filter=login

# Combined usage
GET index.php?/api/v2/get_cases/34&offset=:5&limit=:10&filter=:login

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

پاسخ شامل مجموعه ای از تست‌کیس‌ها است. هر تست‌کیس در آرایه اشیاء “مورد” از همان قالبی پیروی می کند که پاسخ به آن است get_case.

{
    "offset": 0,
    "limit": 250,
    "size": 250,
    "_links": {
        "next": "/api/v2/get_cases/1&limit=250&offset=250",
        "prev": null
    },
    "cases": [
        {
            "id": 1,
            "title": "..",
        },
        {
            "id": 2,
            "title": "..",
        }
    ]
}

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

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

get_history_for_case #

سابقه ویرایش را برای آزمایش برمی گرداند case_id.

GET index.php?/api/v2/get_history_for_case/{case_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
case_id	عدد صحیح	درست است	شناسه پرونده آزمایشی
محدود کردن	عدد صحیح	نادرست	تعداد تغییرات تست‌کیس که پاسخ باید برگردد (اندازه پاسخ به طور پیش فرض ۲۵۰ است) – به TestRail ۶.۷ یا بالاتر نیاز دارد
جبران	عدد صحیح	نادرست	از کجا شروع به شمارش تغییرات تست‌کیس کنیم (افست) – به TestRail ۶.۷ یا بالاتر نیاز دارد

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

نام	تایپ کنید	توضیحات
شناسه	عدد صحیح	تغییر شناسه پرونده آزمایشی
ایجاد_روشن	مهر زمانی	مهر زمانی یونیکس تغییر ایجاد شد
type_id	عدد صحیح	نوع تغییر این مقدار معمولاً ۶ است که نشان‌دهنده «به‌روزرسانی» است. (مقادیر type_id در آرایه “تغییرات” در زیر توضیح داده شده است)
user_id	عدد صحیح	شناسه کاربری که تغییر را انجام داده است
تغییر می کند	آرایه	مجموعه ای از جزئیات برای تغییرات ایجاد شده در تست‌کیس‌ها

فیلدهای زیر را می توان در آن گنجاند changes آرایه:

نام	تایپ کنید	توضیحات
type_id	عدد صحیح	نوع فیلد به روز شده ۱ = رشته ۲ = عدد صحیح ۳ = بولی ۴ = تاریخ ۵ = بازه زمانی ۶ = متن 7 = URL ۸ = گام
متن_قدیمی	متن	مقدار متن قبلی فیلد به روز شده (برای فیلدهای متنی استفاده می شود)
متن_جدید	متن	مقدار متن جدید فیلد به روز شده (برای فیلدهای متنی استفاده می شود)
برچسب	رشته	برچسب فیلد همانطور که در رابط کاربری مشاهده می شود
گزینه ها	آرایه	آرایه ای از گزینه های پیکربندی شده در فیلد، مانند الزامی، مقدار پیش فرض و غیره.
زمینه	رشته	نام سیستم فیلد به روز شده
قدیمی_ارزش	متفاوت است	مقدار قبلی فیلد به روز شده. این برای هر فیلد غیر متنی از جمله فیلد مراحل جدا شده استفاده می شود. بسته به نوع فیلد، مقدار می تواند متن یا عدد صحیح باشد
new_value	متفاوت است	مقدار جدید فیلد به روز شده. این برای هر فیلد غیر متنی از جمله فیلد مراحل جدا شده استفاده می شود. بسته به نوع فیلد، مقدار می تواند متن یا عدد صحیح باشد

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

پاسخ شامل مجموعه ای از تغییرات تست‌کیس است. هر ورودی در آرایه یک رکورد تغییر است:

[
    {
        "offset": 0,
        "limit": 250,
        "size": 1,
        "_links": {
            "next": null,
            "prev": null
        },
        "history": [
            {
                "id": 3382,
                "type_id": 6,
                "created_on": 1597927176,
                "user_id": 1,
                "changes": [
                    {
                        "type_id": 1,
                        "old_text": "Original Section",
                        "new_text": "Updated Section",
                        "field": "section_id",
                        "old_value": 3573,
                        "new_value": 3574
                    },
                ]
            },
            {
                "id": 3389,
                "type_id": 6,
                "created_on": 1597932715,
                "user_id": 1,
                "changes": [
                    {
                        "type_id": 1,
                        "field": "refs",
                        "old_value": null,
                        "new_value": "1"
                    },
                ]
            },
        ]
    }
]

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

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

add_case #

یک تست‌کیس جدید ایجاد می کند.

POST index.php?/api/v2/add_case/{section_id}

پارامترها #

فیلدهای POST زیر پشتیبانی می شوند (فیلدهای سیستم):

نام	تایپ کنید	مورد نیاز	توضیحات
section_id	عدد صحیح	درست است	شناسه بخش تست‌کیس باید به آن اضافه شود
عنوان	رشته	درست است	عنوان پرونده آزمایشی
template_id	عدد صحیح	نادرست	شناسه الگو (طرح فیلد)-به TestRail ۵.۲ یا بالاتر نیاز دارد
type_id	عدد صحیح	نادرست	شناسه نوع مورد
priority_id	عدد صحیح	نادرست	شناسه اولویت پرونده
برآورد	بازه زمانی	نادرست	برآورد، به عنوان مثال «30s» یا «1m 45s»
milestone_id	عدد صحیح	نادرست	شناسه نقطه عطف برای پیوند به پرونده آزمایشی
مراجع	رشته	نادرست	فهرستی از مراجع/شرایط جدا شده با کاما
برچسب ها	آرایه ای از مقادیر مختلط (عدد صحیح یا رشته)	نادرست	شناسه یک برچسب، عنوان یک برچسب یا هر دو، به شکل آرایه.

پارامترهای فیلد سفارشی نیز پشتیبانی می شوند و باید با نام سیستم خود، با پیشوند “custom_” ارسال شوند، به عنوان مثال:

{
    "custom_preconds": "These are the preconditions for a test case"
}

انواع فیلدهای سفارشی زیر پشتیبانی می شوند:

نام	تایپ کنید	توضیحات
چک باکس	بولی	درست برای بررسی و نادرست در غیر این صورت
تاریخ	رشته	تاریخی با همان قالبی که برای TestRail و کاربر API پیکربندی شده است (مثلاً «۰۷/۰۸/۲۰۱۳»)
کشویی	عدد صحیح	شناسه یک مقدار کشویی همانطور که در پیکربندی فیلد پیکربندی شده است
عدد صحیح	عدد صحیح	یک عدد صحیح معتبر
نقطه عطف	عدد صحیح	شناسه یک نقطه عطف برای فیلد سفارشی
چند انتخابی	آرایه	آرایه ای از شناسه ها همانطور که در پیکربندی فیلد پیکربندی شده است
مراحل	آرایه	آرایه ای از اشیاء که مراحل را مشخص می کند. مثال زیر را نیز ببینید
رشته	رشته	یک رشته معتبر با حداکثر طول ۲۵۰ کاراکتر
متن	رشته	رشته ای بدون حداکثر طول
URL	رشته	یک رشته با نحو یک URL مطابقت دارد
کاربر	عدد صحیح	شناسه یک کاربر برای فیلد سفارشی

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

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

{
    "title": "This is a test case",
    "type_id": 1,
    "priority_id": 3,
    "estimate": "3m",
    "refs": "RF-1, RF-2",
    "custom_steps_separated": [
        {
            "content": "Step 1",
            "expected": "Expected Result 1"
        },
        {
            "content": "Step 2",
            "expected": "Expected Result 2"
        },
        {
            "shared_step_id": 3
        },
    "labels": [
     ‘label1, ‘label5’,7,9,10,’label8’
       ]
    ]
}

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

در صورت موفقیت آمیز بودن، این روش تست‌کیس جدید را با استفاده از همان قالب پاسخ بازمی گرداند get_case. پاسخ نمونه:

{
    "id": 1,
    "title": "Print document history and attributes",
    "section_id": 1,
    "template_id": 1,
    "type_id": 2,
    "priority_id": 2,
    "milestone_id": null,
    "refs": null,
    "created_by": 1,
    "created_on": 1646317844,
}

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

نام	تایپ کنید	توضیحات
ایجاد_توسط	عدد صحیح	شناسه کاربری که تست‌کیس را ایجاد کرده است
ایجاد_روشن	مهر زمانی	تاریخ/زمانی که تست‌کیس ایجاد شد (به عنوان مهر زمانی یونیکس)
برآورد	بازه زمانی	برآورد، به عنوان مثال «30s» یا «1m 45s»
تخمین_پیش بینی	بازه زمانی	پیش بینی برآورد، به عنوان مثال «30s» یا «1m 45s»
شناسه	عدد صحیح	شناسه منحصر به فرد تست‌کیس
milestone_id	عدد صحیح	شناسه نقطه عطف که به پرونده آزمایشی مرتبط است
priority_id	عدد صحیح	شناسه اولویتی که به پرونده آزمایشی مرتبط است
مراجع	رشته	فهرستی از ارجاعات/شرایط جدا شده با کاما که به پرونده آزمایشی مرتبط هستند
section_id	عدد صحیح	شناسه بخشی که تست‌کیس به آن تعلق دارد
suite_id	عدد صحیح	شناسه مجموعه تست‌کیس متعلق به آن است
template_id	عدد صحیح	شناسه الگو (طرح فیلد) تست‌کیس مورد استفاده قرار می گیرد-به TestRail ۵.۲ یا بالاتر نیاز دارد
عنوان	رشته	عنوان پرونده آزمایشی
type_id	عدد صحیح	شناسه نوع تست‌کیس که به پرونده آزمایشی پیوند داده شده است
به روز شده_توسط	عدد صحیح	شناسه کاربری که آخرین بار تست‌کیس را به‌روزرسانی کرده است
updated_on	مهر زمانی	تاریخ/زمان آخرین به‌روزرسانی پرونده آزمایشی (به عنوان مهر زمانی یونیکس)

فیلدهای سفارشی نیز در پاسخ گنجانده شده اند و از نام سیستم خود با پیشوند “custom_” به عنوان شناسه فیلد خود استفاده می کنند. لطفا ببینید add_case برای لیست کامل انواع فیلدهای سفارشی موجود.

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

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

copy_cases_to_section #

لیست موارد را در مجموعه/بخش دیگری کپی می کند.

POST index.php?/api/v2/copy_cases_to_section/{section_id}

پارامترها #

فیلدهای POST زیر پشتیبانی می شوند (فیلدهای سیستم):

نام	تایپ کنید	مورد نیاز	توضیحات
section_id	عدد صحیح	درست است	شناسه بخش تست‌کیس باید در آن کپی شود
case_ids	آرایه ای از اعداد صحیح	نادرست	فهرستی از شناسه‌های پرونده جدا شده با کاما

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

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

update_case #

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

POST index.php?/api/v2/update_case/{case_id}

پارامترها #

فیلدهای POST زیر پشتیبانی می شوند (فیلدهای سیستم):

نام	تایپ کنید	مورد نیاز	توضیحات
case_id	عدد صحیح	درست است	شناسه پرونده آزمایشی
section_id	عدد صحیح	نادرست	شناسه بخش تست‌کیس باید به روز شود
عنوان	رشته	نادرست	عنوان پرونده آزمایشی
template_id	عدد صحیح	نادرست	شناسه الگو (طرح فیلد)-به TestRail ۵.۲ یا بالاتر نیاز دارد
type_id	عدد صحیح	نادرست	شناسه نوع مورد
priority_id	عدد صحیح	نادرست	شناسه اولویت پرونده
برآورد	بازه زمانی	نادرست	برآورد، به عنوان مثال «30s» یا «1m 45s»
milestone_id	عدد صحیح	نادرست	شناسه نقطه عطف برای پیوند به پرونده آزمایشی
مراجع	رشته	نادرست	فهرستی از مراجع/شرایط جدا شده با کاما
برچسب ها	آرایه ای از مقادیر مختلط (عدد صحیح یا رشته)	نادرست	شناسه یک برچسب، عنوان یک برچسب یا هر دو، به شکل آرایه.

این روش از همان فیلدهای POST پشتیبانی می کند add_case. به روز رسانی بخش_id یک مورد به TestRail ۶.۵.۲ یا بالاتر نیاز دارد.

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

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

{
    "priority_id": 1,
    "estimate": "5m"
}

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

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

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

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

update_cases #

چندین تست‌کیس را با مقادیر یکسان به‌روزرسانی می‌کند، مانند تنظیم مجموعه‌ای از تست‌کیس‌ها روی اولویت «بالا». این از به‌روزرسانی چند تست‌کیس با مقادیر مختلف در هر تست‌کیس پشتیبانی نمی‌کند.

POST index.php?/api/v2/update_cases/{suite_id}

پارامترها #

فیلدهای POST زیر پشتیبانی می شوند (فیلدهای سیستم):

نام	تایپ کنید	مورد نیاز	توضیحات
case_ids	آرایه ای از اعداد صحیح	درست است	شناسه مواردی که باید به روز شوند
suite_id	عدد صحیح	توضیحات را ببینید	شناسه مجموعه آزمایشی (در صورتی که پروژه در حالت تک مجموعه کار می کند اختیاری است)
section_id	عدد صحیح	نادرست	شناسه بخش تست‌کیس باید به روز شود
عنوان	رشته	نادرست	عنوان پرونده آزمایشی
template_id	عدد صحیح	نادرست	شناسه الگو (طرح فیلد)-به TestRail ۵.۲ یا بالاتر نیاز دارد
type_id	عدد صحیح	نادرست	شناسه نوع مورد
priority_id	عدد صحیح	نادرست	شناسه اولویت پرونده
برآورد	بازه زمانی	نادرست	برآورد، به عنوان مثال «30s» یا «1m 45s»
milestone_id	عدد صحیح	نادرست	شناسه نقطه عطف برای پیوند به پرونده آزمایشی
مراجع	رشته	نادرست	فهرستی از مراجع/شرایط جدا شده با کاما
برچسب ها	آرایه ای از مقادیر مختلط (عدد صحیح یا رشته)	نادرست	شناسه یک برچسب، عنوان یک برچسب یا هر دو، به شکل آرایه.

این روش از همان فیلدهای POST پشتیبانی می کند add_case. به روز رسانی بخش_id یک مورد به TestRail ۶.۵.۲ یا بالاتر نیاز دارد.

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

همچنین، مثال زیر را ببینید که نحوه به روز رسانی فیلدهای اولویت و تخمین را برای یک تست‌کیس نشان می دهد. را case_ids فیلد یک فیلد الزامی است و تست‌کیس‌ها را نشان می دهد که باید به روز شوند:

{
    "case_ids": [1, 2, 3],
    "priority_id": 1,
    "estimate": "5m"
}

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

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

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

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

move_cases_to_section #

موارد را به مجموعه یا بخش دیگری منتقل می کند.

POST index.php?/api/v2/move_cases_to_section/{section_id}

پارامترها #

فیلدهای POST زیر پشتیبانی می شوند (فیلدهای سیستم):

نام	تایپ کنید	مورد نیاز	توضیحات
section_id	عدد صحیح	درست است	شناسه قسمت مورد به آن منتقل خواهد شد
suite_id	عدد صحیح	درست است	شناسه سوئیت مورد به آن منتقل خواهد شد
case_ids	آرایه ای از اعداد صحیح	درست است	فهرستی از شناسه‌های پرونده جدا شده با کاما

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

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

delete_case #

یک تست‌کیس موجود را حذف می کند.

POST index.php?/api/v2/delete_case/{case_id}

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
case_id	عدد صحیح	درست است	شناسه پرونده آزمایشی
نرم	عدد صحیح	نادرست	soft=۱ اطلاعاتی را در مورد داده‌هایی که حذف می‌شوند برمی‌گرداند اما با حذف ادامه نمی‌یابد

پارامتر نرم #

اگر soft=1، داده های مربوط به تعداد تست های تحت تأثیر را برمی گرداند.

از جمله soft=1 در واقع موجودیت را حذف نخواهد کرد.

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

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

delete_cases #

چندین تست‌کیس را از یک پروژه یا مجموعه آزمایشی حذف می کند.

POST index.php?/api/v2/delete_cases/{suite_id}&soft=1

پارامترها #

نام	تایپ کنید	مورد نیاز	توضیحات
case_ids	آرایه ای از اعداد صحیح	درست است	مجموعه‌ای از شناسه‌های تست‌کیس‌ها که می‌خواهید حذف کنید
پروژه_id	عدد صحیح	درست است	شناسه پروژه
suite_id	عدد صحیح	توضیحات را ببینید	شناسه مجموعه (فقط در صورتی لازم است که پروژه در حالت چند مجموعه باشد)
نرم	عدد صحیح	نادرست	soft=۱ اطلاعاتی را در مورد داده‌هایی که حذف می‌شوند برمی‌گرداند اما با حذف ادامه نمی‌یابد

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

همچنین مثال زیر را ببینید که شناسه های case از پروژه انتخاب شده را نشان می دهد.

{
    "case_ids": [1, 2, 3]
}

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

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