api:forum topics

The following includes the details of how to interface with the forum topic records through the API.

Record field format

Category ID

Associated attributes

Nomenclature

• Plural form: "forum_topics"
• Used in the URL pathname
• Singular form: "forum_topic"
• Used for write parameters (Help:API Write Requests)
• Versions: none

Index

Search attributes

All of the following are standard attributes with all of their available formats and qualifiers.

• Number syntax
• id
• category_id
• response_count
• created_at
• updated_at
• Text syntax
• title
• User syntax
• creator
• updater
• Boolean syntax
• is_deleted
• is_sticky
• is_locked
• Chaining syntax
• forum_posts
• bulk_update_requests
• tag_aliases
• tag_implications

Special search parameters

• title_matches - Case-insensitive wildcard searching on the title text field.
• status - The status of an attached BUR. Can be: pending, approved, rejected.
• is_private - Shows topics that have a min level set or not (Help:Boolean syntax).
• is_read - Shows topics that have been read by the user or not (Help:Boolean syntax).
• is_deleted - Unless this value is present, deleted forum_topics are hidden.

Search order

Using the search parameter order with one of the following values changes the order of the results.

• sticky - Shows sticky topics first, sorted by updated at second.
• post_count - Orders by post count.

The order can also be changed to ID descending by using sequential pagination.

Show

Create

Create parameters

• Required:
• title
• category_id - Can be: 0, 1, 2.
• Optional
• original_post_attributes[body] - DText that will be used to create a forum post entry at the same time.
• Is a hash value, so the final parameter format is forum_topic[original_post_attributes][body]

Restricted to Moderator+

• Optional
• min_level - Can be: 0, 40, 50
• is_sticky
• is_locked
• is_deleted

Update

Update parameters

Accepts the same parameters as the create forum topic action. All parameters are optional. Besides those, it also accepts the following additional optional parameters.

• original_post_attributes[id] - The ID of the the first post on a topic.
• Is a hash value, so the final parameter format is forum_topic[original_post_attributes][id]
• This parameter is required if the original post's body is being updated as well.

Delete

Note: This action can also be accomplished using the update forum topic action by setting is_deleted to true.

Undelete

Note: This action can also be accomplished using the update forum topic action by setting is_deleted to false.

Mark all as read

Marks every topic as being read.

See also

• Help:Common URL Parameters
• Help:API

External links