<< Back to GForge REST API

Entity: Forummessage

GET

getAttachment

Get binary object corresponding to an attachment for a given forum message item and attachment id

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters See description for details about expected properties. *

Return: (none)

No return type is defined

Example 1

Retrieve binary object for a specified message ID and attachment ID:
  GET http://api.mygforge.tld/forummessage/2/attachment/5/some-picture.png

getChildcount

Retrieve an the number of children messages under a given message id.

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters

Return: \Object

count of child messages.

getForummessage

Retrieve an individual forum message by its unique identifier.

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters

Return: \api\ForumMessageBasic|\api\ForumMessageBasic[]

No return type is defined

getForummessagesBetweenIdsByThreadId

Parameters (0)

Name Type Description
No parameters

Return: (none)

No return type is defined

getLocation

Retrieve an individual forum message by its unique identifier.

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters

Return: \gforge\plugins\forum\models\api\ForumMessageBasic

The record that was found.

Name Type Description
id int Unique database identifier for the forum message
subject string subject for this message
body string body of this message
postDate \DateTime when was the message posted
forumThread \The ID of the thread to which the messages belongs
parentForumMessageId \The ID of the forum message object that is parent of this message, 0 if none
user int ID of the user that posted the message

POST

postAttachment

Processes a forum message item attachment upload

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: array

Array with API location to attachment

postForummessage

Create a new Forum Message, or update an existing one.

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters

Return: mixed

The API URL for the newly-created or updated message.

PUT

DELETE

deleteForumMessage

Deletes a Forum Message

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters

Return: array

No return type is defined