Skip to main content
#P1758

RESOURCE /v2/scrumboard/boards

List Scrum Boards

این اندپوینت لیست بوردهای اسکرام را بازیابی می‌کند. نتایج شامل بوردهایی است که کاربر جاری یا سازنده (Owner) آن‌هاست و یا به عنوان عضو (Member) در آن‌ها دعوت شده است.

Request Overview

URL: /v2/scrumboard/boards
Method: GET
Controller: BoardController@index
Middleware: authWithJwt

Parameters

Parameter Type Location Description
branch Integer Query شناسه شعبه (الزامی برای فیلتر اولیه).
status Integer Query (اختیاری) فیلتر بر اساس وضعیت فعال/غیرفعال.

Logic Details

سیستم پردازش‌های زیر را انجام می‌دهد:

  • فیلتر دسترسی: تنها بوردهایی بازگردانده می‌شوند که operator_id برابر با کاربر جاری باشد یا شناسه کاربر در آرایه JSON ستون members وجود داشته باشد.
  • Hydration (تزریق داده‌ها):
    • فیلد members که در دیتابیس آرایه‌ای از IDهاست، با اطلاعات کامل اپراتورها (نام، آواتار و...) جایگزین می‌شود.
    • لیست‌های بورد (Lists) از جدول scrumboard_lists دریافت و اضافه می‌شوند.
    • لیبل‌های بورد (Labels) از جدول scrumboard_labels دریافت و اضافه می‌شوند.

Response Structure

نمونه پاسخ موفق

{
    "items": [
        {
            "id": 10,
            "title": "پروژه توسعه",
            "operator_id": 55,
            "members": [
                { "id": 60, "first_name": "Ali", "last_name": "Rezaei", "avatar": "..." }
            ],
            "lists": [
                { "id": 1, "title": "درحال انجام", "priority": 2 }
            ],
            "labels": [
                { "id": 5, "title": "فوری" }
            ]
        }
    ],
    "meta": { "timestamp": 1733754000 }
}