Skip to main content
#P1760

RESOURCE /v2/scrumboard/labels


Label Logic Flow

منطق پردازش ساده برای مدیریت لیبل‌ها (برچسب‌ها) که مستقیماً با دیتابیس در تعامل است:

Start Request
↓
Request Type?
GET (Index/Show)
Fetch from `scrumboard_labels`
↓
Return Data or False
POST/PUT
Insert/Update DB
Set Timestamps
↓
Fetch Updated Record
↓
Return Payload
DELETE
Delete by ID
↓
Return Count (0/1)

Get Board Labels

دریافت لیست تمامی لیبل‌های تعریف شده برای یک بورد خاص.

URL: /v2/scrumboard/labels
Method: GET
Controller: LabelController@index

Parameters

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

Response Structure

نکته: اگر داده‌ای یافت نشود، مقدار items برابر با false خواهد بود.

{
    "items": [
        {
            "id": 1,
            "board_id": 10,
            "title": "Bug Fix",
            "status": 1,
            "created_at": "2023-12-01 10:00:00",
            "updated_at": "2023-12-01 10:00:00"
        }
    ],
    "meta": { "timestamp": 1733754000 }
}

Create Label

ایجاد یک لیبل جدید برای بورد.

URL: /v2/scrumboard/labels
Method: POST
Controller: LabelController@store

Parameters

Parameter Type Description
board_id Integer شناسه بورد والد.
title String عنوان لیبل.

Success Response

{
    "payload": {
        "id": 5,
        "board_id": 10,
        "title": "Urgent",
        "created_at": "...",
        "updated_at": "..."
    },
    "meta": { "timestamp": 1733754000 }
}

Show Label

دریافت جزئیات یک لیبل خاص.

URL: /v2/scrumboard/labels/{id}
Method: GET
Controller: LabelController@show

Path Parameters

Parameter Type Description
id Integer شناسه لیبل.

Response

اگر لیبل یافت نشود، مقدار payload برابر با false خواهد بود.

{
    "payload": {
        "id": 5,
        "board_id": 10,
        "title": "Urgent",
        "status": 1,
        ...
    },
    "meta": { "timestamp": 1733754000 }
}

Update Label

ویرایش نام، وضعیت یا انتقال لیبل به بورد دیگر.

URL: /v2/scrumboard/labels/{id}
Method: PUT / PATCH
Controller: LabelController@update

Parameters

Parameter Type Description Default
board_id Integer شناسه بورد. -
title String عنوان جدید لیبل. -
status Integer وضعیت (1 فعال، 0 غیرفعال). 1

Success Response

{
    "payload": {
        "id": 5,
        "board_id": 10,
        "title": "New Title",
        "status": 1,
        "updated_at": "..."
    },
    "meta": { "timestamp": 1733754000 }
}

Delete Label

حذف لیبل از دیتابیس.

URL: /v2/scrumboard/labels/{id}
Method: DELETE
Controller: LabelController@destroy

Success Response

{
    "payload": 1, // تعداد ردیف‌های حذف شده
    "meta": {
        "timestamp": 1733754000
    }
}
Back to top