دسته‌ها را مشاهده کنید

مرجع API

27 مستندات

BDDها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

برای export یا import کردن سناریوهای BDD مربوط به test caseها، از متدهای API زیر استفاده کنید. get_bdd یک سناریوی BDD را از یک test case به‌صورت فایل .feature export می‌کند. پارامت

تست‌ها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از روش‌های زیر API برای دریافت جزئیات testها استفاده کنید؛ منظور از test، نمونه‌ای از یک test case است که به یک test run یا test plan مشخص اضافه شده است. get_test یک test موجود را

متغیرها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

برای بارگذاری، دریافت، به‌روزرسانی و حذف متغیرهایی که در datasetها وجود دارند، از متدهای API زیر استفاده کنید. get_variables متغیرهای درخواستی را برمی‌گرداند. پارامترها نام نوع الز

کاربران

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

برای درخواست جزئیات درباره کاربران، از متدهای زیر API استفاده کنید. get_user یک کاربر موجود را برمی‌گرداند. پارامترها نام نوع الزامی توضیحات user_id integer true ID کاربر محتوای پا

templateها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

برای درخواست جزئیات درباره templateها (چیدمان فیلدهای case/result)، از متدهای زیر API استفاده کنید. get_templates فهرست templateهای موجود را برای یک project برمی‌گرداند . پارامترها

test suiteها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

برای درخواست جزئیات درباره test suiteها و ایجاد یا ویرایش آن‌ها، از متدهای زیر API استفاده کنید. get_suite یک test suite موجود را برمی‌گرداند. پارامترها نام نوع الزامی توضیحات suit

Statusها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از روش‌های API زیر برای دریافت جزئیات statusهای تست استفاده کنید. get_case_statuses این endpoint به TestRail Enterprise 7.3 یا نسخه‌های جدیدتر نیاز دارد. فهرستی از statusهای موجود

گام‌های مشترک

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از روش‌های API زیر برای دریافت جزئیات گام‌های مشترک استفاده کنید. گام‌های تست مشترک و endpointهای مرتبط فقط در TestRail 7.0 یا نسخه‌های جدیدتر در دسترس هستند. get_shared_step یک مج

section‌ها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

برای دریافت جزئیات section‌ها و ایجاد یا تغییر آن‌ها، از متدهای زیر API استفاده کنید. از section‌ها برای گروه‌بندی و سازمان‌دهی test case‌ها در test suite‌ها استفاده می‌شود. get_se

test runها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از متدهای API زیر برای دریافت جزئیات test runها و ایجاد یا ویرایش test runها استفاده کنید. get_run یک test run موجود را برمی‌گرداند. برای دیدن فهرست testهای موجود در این run، get_t

فیلدهای نتیجه تست

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از متدهای API زیر برای دریافت جزئیات فیلدهای سیستمی و سفارشیِ نتایج تست استفاده کنید. get_result_fields فهرستی از فیلدهای سفارشی موجود برای نتیجه تست را برمی‌گرداند. محتوای پاسخ پا

نقش‌ها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

برای دریافت جزئیات نقش‌ها، از متدهای API زیر استفاده کنید. get_roles فهرست نقش‌های موجود را برمی‌گرداند این endpoint به TestRail 7.3 یا نسخه‌های جدیدتر نیاز دارد. محتوای پاسخ (Test

گزارش‌ها و گزارش‌های بین‌پروژه‌ای

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

برای دریافت و اجرای reportهای تک‌project که در دسترس API قرار گرفته‌اند، از روش‌های زیر استفاده کنید. قبل از دسترسی به report از طریق endpointهای API، باید report خود را در دسترس A

نتایج

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از API متدهای زیر برای دریافت جزئیات test resultها و اضافه کردن test resultهای جدید استفاده کنید. get_results فهرستی از test resultهای یک test را برمی‌گرداند. پارامترها نام نوع الز

Projectها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از متدهای API زیر برای دریافت جزئیات projectها و ایجاد یا ویرایش projectها استفاده کنید. get_project یک project موجود را برمی‌گرداند. پارامترها نام نوع الزامی توضیح project_id inte

Priorityها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از متدهای API زیر برای دریافت جزئیات فیلد priority در test caseها استفاده کنید. get_priorities فهرست priorityهای موجود برای test caseها را برمی‌گرداند. محتوای پاسخ پاسخ شامل آرایه‌

Milestoneها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از متدهای API زیر برای دریافت جزئیات milestoneها و ایجاد یا ویرایش milestoneها استفاده کنید. get_milestone یک milestone موجود را برمی‌گرداند. پارامترها نام نوع الزامی توضیح milesto

test planها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از متدهای API زیر برای گرفتن جزئیات test planها و ایجاد یا تغییر آن‌ها استفاده کنید. در TestRail، test plan به شما کمک می‌کند چند test run را با هم گروه‌بندی کنید و برای مرورگر، سی

گروه‌ها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از متدهای API زیر برای دریافت جزئیات گروه‌ها استفاده کنید. endpointهای گروه‌ها فقط در TestRail 7.5 یا نسخه‌های بعدی در دسترس هستند. get_group یک گروه موجود را برمی‌گرداند. پارامتره

Datasetها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از متدهای API زیر برای آپلود، دریافت، به‌روزرسانی و حذف datasetها استفاده کنید. get_dataset parameter مربوط به dataset درخواستی را دریافت می‌کند. پارامترها نام نوع الزامی توضیحات d

Configurationها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از متدهای زیر API برای دریافت جزئیات configurationهای test plan و ایجاد یا تغییر configurationهایی استفاده کنید که برای ساخت test plan به کار می‌روند. get_configs فهرست configurati

انواع test case

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از روش‌های API زیر برای دریافت جزئیات نوع‌های test case استفاده کنید. get_case_types فهرست نوع‌های test case موجود را برمی‌گرداند. محتوای پاسخ پاسخ شامل آرایه‌ای از نوع‌های test ca

test caseها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از روش‌های API زیر برای دریافت داده‌های مربوط به test caseها، مثل عنوان، فیلدهای test case و history، و همچنین ایجاد، ویرایش یا حذف test caseها استفاده کنید. get_case یک test case

فیلدهای test case

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از روش‌های API زیر برای دریافت جزئیات فیلدهای سفارشی test caseها استفاده کنید. get_case_fields فهرست فیلدهای سفارشی موجود برای test caseها را برمی‌گرداند. محتوای پاسخ پاسخ شامل آرا

پیوست‌ها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

از روش‌های API زیر برای آپلود، دریافت و حذف پیوست‌ها استفاده کنید. هنگام آپلود پیوست‌ها از طریق TestRail API با requestهای POST، باید از headerهای زیر استفاده کنید: پیوست باید به‌ص

فیلدهای فیلتر پویا

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

برای دریافت فهرست فیلدهایی که هنگام ایجاد یا به‌روزرسانی test run و test plan برای فیلتر پویا در دسترس هستند، از متد API زیر استفاده کنید. get_dynamic_filter_fields فهرست فیلدهای ق

برچسب‌ها

آخرین به‌روزرسانی: ۱۴۰۵-۰۴-۱۷

برای دریافت جزئیات مربوط به labelها، از متدهای API زیر استفاده کنید. get_label یک label موجود را برمی‌گرداند. پارامترها نام نوع الزامی توضیحات label_id integer true ID برچسب. محتوا