Project

General

Profile

Actions

Feature #44141

open

Add REST API for forums

Added by Go MAEDA about 14 hours ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
REST API
Resolution:

Description

Redmine does not currently provide REST API support for boards and forum messages.

This patch adds REST API support for the following forum-related resources:

  • Boards
  • Topics
  • Replies
  • Direct access to messages by ID

Boards:

A board corresponds to a forum in a project and contains discussion topics. A project can have multiple boards.

  • GET /projects/:project_id/boards.{xml,json}
  • POST /projects/:project_id/boards.{xml,json}
  • GET /boards/:id.{xml,json}
  • PUT/PATCH /boards/:id.{xml,json}
  • DELETE /boards/:id.{xml,json}

Topics and replies:

A topic is the initial message in a forum discussion, while replies are messages posted in response to that topic. A topic may have multiple replies.

  • GET /boards/:board_id/topics.{xml,json}
  • POST /boards/:board_id/topics.{xml,json}
  • GET /messages/:topic_id/replies.{xml,json}
  • POST /messages/:topic_id/replies.{xml,json}

Messages:

The message API provides direct access to individual topics and replies by ID. It works for both resource types because they are stored as Message records.

  • GET /messages/:id.{xml,json}
  • PUT/PATCH /messages/:id.{xml,json}
  • DELETE /messages/:id.{xml,json}

Files

No data to display

Actions

Also available in: Atom PDF