بخش‌ها (Boards)

نوع‌های مشترک (Common Types)

فیلدهای Board:

مدیریت بخش‌ها (Boards)

دریافت لیست تمام بخش‌ها

GET https://api.fidegah.ir/v1/boards

curl -X GET https://api.fidegah.ir/v1/boards \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

پارامترهای Query (Query Parameters):

خروجی درخواست: آرایه‌ای از Board.

دریافت بخش با شناسه

GET https://api.fidegah.ir/v1/boards/:id

curl -X GET https://api.fidegah.ir/v1/boards/{id} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

پارامترهای مسیر (Path Parameters):

خروجی درخواست: شیء Board درخواستی.

ایجاد بخش جدید

POST https://api.fidegah.ir/v1/boards

curl -X POST https://api.fidegah.ir/v1/boards \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "بخش من",
    "url": "myBoard",
    "isPrivate": false
  }'

بدنه درخواست (Request Body):

اولین بخشی که در یک فضای کاری ساخته می‌شود، به‌صورت خودکار پیش‌فرض (isDefault: true) می‌شود و بخش‌های بعدی همیشه isDefault: false خواهند بود؛ این مقدار دیگر از طریق بدنه‌ی درخواست قابل تنظیم نیست.

خروجی درخواست: شیء Board ایجادشده.

ویرایش بخش

PATCH https://api.fidegah.ir/v1/boards/:id

curl -X PATCH https://api.fidegah.ir/v1/boards/{id} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "عنوان جدید"
  }'

پارامترهای مسیر (Path Parameters):

بدنه درخواست (Request Body - همگی اختیاری):

خروجی درخواست: شیء Board پس از ویرایش.

حذف بخش

DELETE https://api.fidegah.ir/v1/boards/:id

curl -X DELETE https://api.fidegah.ir/v1/boards/{id} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

پارامترهای مسیر (Path Parameters):

خروجی درخواست:

بخش پیش‌فرض (isDefault: true) قابل حذف نیست؛ ابتدا باید یک بخش دیگر را به‌عنوان پیش‌فرض تنظیم کرد.