api:forum posts
The following includes the details of how to interface with the forum post records through the API.
Record field format
- id: integer, > 0
- topic_id: integer, > 0
- creator_id: integer, > 0
- updater_id: integer, > 0
- body: body
- is_deleted: boolean
- created_at: timestamp
- updated_at: timestamp
Associated attributes
- creator - The user that created the forum post.
- updater - The user that last updated the forum post.
- topic - The forum topic the forum post is on.
- votes - Any votes the forum post may have.
- tag_alias - Any tag alias linked to the forum post.
- tag_implication - Any tag implication linked to the forum post.
- bulk_update_request - Any bulk update request linked to the forum post.
Nomenclature
- Plural form: "forum_posts"
- Used in the URL pathname
- Singular form: "forum_post"
- Used for write parameters (Help:API Write Requests)
- Versions: none
Actions
These are the various actions that can be done with forum post records.
Index
The base URL is GET /forum_posts.json
Search attributes
All of the following are standard attributes with all of their available formats and qualifiers.
- Number syntax
id
topic_id
created_at
updated_at
- Text syntax
body
- User syntax
creator
updater
- Boolean syntax
is_deleted
Special search parameters
-
body_matches
- Case-insensitive wildcard searching on the body text field. -
topic_title_matches
- Case-insensitive wildcard searching on the topic title the forum post is on. -
topic_category_id
- Can be: 0, 1, 2 (General, Tags, Bugs & Features respectively). -
linked_to
- Shows forum posts that link to a particular wiki - The parameter must use the same format as the wiki title
- I.e. all lowercase and underscores instead of spaces
Note: The default order is updated at descending.
Show
The base URL is GET /forum_posts/$id.json where $id is the forum post ID.
Create
The base URL is POST /forum_posts.json
Create parameters
- Required:
body
topic_id
Update
The base URL is PUT /forum_posts/$id.json where $id is the forum post ID.
Update parameters
- Optional:
body
Delete
The base URL is DELETE /forum_posts/$id.json where $id is the forum post ID.
Undelete
The base URL is POST /forum_posts/$id/undelete.json where $id is the forum post ID.