This page has details for how to interact with forum post records through the API.
[hr]
Record field format
[table]
[thead]
[tr]
[th]Name[/th]
[th]Type[/th]
[th]Details[/th]
[/tr]
[/thead]
[tbody]
[tr]
[td][code]id[/code][/td]
[td]integer[/td]
[td]>0[/td]
[/tr]
[tr]
[td][code]topic_id[/code][/td]
[td]integer[/td]
[td]>0[/td]
[/tr]
[tr]
[td][code]body[/code][/td]
[td]string[/td]
[td][/td]
[/tr]
[tr]
[td][code]is_deleted[/code][/td]
[td]boolean[/td]
[td][/td]
[/tr]
[tr]
[td][code]creator_id[/code][/td]
[td]integer[/td]
[td]>0[/td]
[/tr]
[tr]
[td][code]updater_id[/code][/td]
[td]integer[/td]
[td]>0[/td]
[/tr]
[tr]
[td][code]created_at[/code][/td]
[td]timestamp[/td]
[td][/td]
[/tr]
[tr]
[td][code]updated_at[/code][/td]
[td]timestamp[/td]
[td][/td]
[/tr]
[/tbody]
[/table]
[hr]
Associated attributes
The following is the list of relations that can be included in the API results (see Help:Common URL Parameters for more info):
[table]
[thead]
[tr]
[th]Name[/th]
[th]Type[/th]
[th]Number[/th]
[th]Availability[/th]
[th]Details[/th]
[/tr]
[/thead]
[tbody]
[tr]
[td][code]creator[/code][/td]
[td]user[/td]
[td]single[/td]
[td]required[/td]
[td]User that created the forum post.[/td]
[/tr]
[tr]
[td][code]updater[/code][/td]
[td]user[/td]
[td]single[/td]
[td]required[/td]
[td]User that last updated the forum post.[/td]
[/tr]
[tr]
[td][code]topic[/code][/td]
[td]forum topic[/td]
[td]single[/td]
[td]required[/td]
[td]Forum topic the forum post is on.[/td]
[/tr]
[tr]
[td][code]dtext_links[/code][/td]
[td]dtext link[/td]
[td]multiple[/td]
[td]optional[/td]
[td]Dtext links on the forum post.[/td]
[/tr]
[tr]
[td][code]votes[/code][/td]
[td]forum post vote[/td]
[td]multiple[/td]
[td]optional[/td]
[td]Any votes the forum post may have.[/td]
[/tr]
[tr]
[td][code]tag alias[/code][/td]
[td]tag alias[/td]
[td]multiple[/td]
[td]optional[/td]
[td]Tag aliases linked to the forum post.[/td]
[/tr]
[tr]
[td][code]tag implication[/code][/td]
[td]tag implication[/td]
[td]multiple[/td]
[td]optional[/td]
[td]Tag implications linked to the forum post.[/td]
[/tr]
[tr]
[td][code]bulk update request[/code][/td]
[td]bulk update request[/td]
[td]multiple[/td]
[td]optional[/td]
[td]Bulk update requests linked to the forum post.[/td]
[/tr]
[/tbody]
[/table]
[hr]
Index
Returns multiple forum post records.
[table]
[tbody]
[tr]
[td]HTTP Method[/td]
[td]GET[/td]
[/tr]
[tr]
[td]Base URL[/td]
[td][code]/forum_posts.json[/code][/td]
[/tr]
[tr]
[td]Type[/td]
[td]read request[/td]
[/tr]
[tr]
[td]Description[/td]
[td]The default order is updated at descending.[/td]
[/tr]
[/tbody]
[/table]
Search attributes
Search parameters take the following format (see Help:Common URL Parameters for more info):
[code]
search[FIELD]=VALUE
[/code]
The following are the base fields along with their associated type. Check the syntax pages for all of the available variations.
- Number syntax
- [code]id[/code]
- [code]topic_id[/code]
- [code]created_at[/code]
- [code]updated_at[/code]
- Text syntax
- [code]body[/code]
- User syntax
- [code]creator[/code]
- [code]updater[/code]
- Boolean syntax
- [code]is_deleted[/code]
- Chaining syntax
- [code]topic[/code]
- [code]dtext_links[/code]
- [code]votes[/code]
- [code]tag alias[/code]
- [code]tag implication[/code]
- [code]bulk update request[/code]
Special search parameters
The following are additional search fields.
- [code]linked_to[/code] - 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.
Search order
Using the search parameter [code]order[/code] with one of the following values changes the order of the results.
- [code]custom[/code] - Help:Common URL Parameters
- In order to use this order, [code]search[id][/code] must also be set with a list of comma-separated IDs.
[hr]
Show
Returns a single forum post record.
[table]
[tbody]
[tr]
[td]HTTP Method[/td]
[td]GET[/td]
[/tr]
[tr]
[td]Base URL[/td]
[td][code]/forum_posts/$id.json[/code][/td]
[/tr]
[tr]
[td]Type[/td]
[td]read request[/td]
[/tr]
[tr]
[td]Description[/td]
[td][code]$id[/code] is the forum post ID.[/td]
[/tr]
[/tbody]
[/table]
[hr]
Create
Creates a single forum post record.
[table]
[tbody]
[tr]
[td]HTTP Method[/td]
[td]POST[/td]
[/tr]
[tr]
[td]Base URL[/td]
[td][code]/forum_posts.json[/code][/td]
[/tr]
[tr]
[td]Type[/td]
[td]write request[/td]
[/tr]
[/tbody]
[/table]
Create parameters
- Required:
- [code]body[/code]
- [code]topic_id[/code]
[hr]
Update
Updates a single forum post record.
[table]
[tbody]
[tr]
[td]HTTP Method[/td]
[td]PUT/PATCH[/td]
[/tr]
[tr]
[td]Base URL[/td]
[td][code]/forum_posts/$id.json[/code][/td]
[/tr]
[tr]
[td]Type[/td]
[td]write request[/td]
[/tr]
[tr]
[td]Description[/td]
[td][code]$id[/code] is the forum post ID.[/td]
[/tr]
[/tbody]
[/table]
Update parameters
- Optional:
- [code]body[/code]
[hr]
Delete
Deletes a single forum post record.
[table]
[tbody]
[tr]
[td]HTTP Method[/td]
[td]DELETE[/td]
[/tr]
[tr]
[td]Base URL[/td]
[td][code]/forum_posts/$id.json[/code][/td]
[/tr]
[tr]
[td]Type[/td]
[td]write request[/td]
[/tr]
[tr]
[td]Description[/td]
[td][code]$id[/code] is the forum post ID.
Restricted to Moderator+.[/td]
[/tr]
[/tbody]
[/table]
[hr]
Undelete
Undeletes a single forum post record.
[table]
[tbody]
[tr]
[td]HTTP Method[/td]
[td]POST[/td]
[/tr]
[tr]
[td]Base URL[/td]
[td][code]/forum_posts/$id/undelete.json[/code][/td]
[/tr]
[tr]
[td]Type[/td]
[td]write request[/td]
[/tr]
[tr]
[td]Description[/td]
[td][code]$id[/code] is the forum post ID.
Restricted to Moderator+.[/td]
[/tr]
[/tbody]
[/table]
[hr]
See also
[hr]
External links
[table]
[tbody]
[tr]
[td]Controller[/td]
[td]<https://github.com/danbooru/danbooru/blob/master/app/controllers/forum_posts_controller.rb>[/td]
[td][/td]
[/tr]
[tr]
[td]Model[/td]
[td]<https://github.com/danbooru/danbooru/blob/master/app/models/forum_post.rb>[/td]
[/tr]
[tr]
[td]Policy[/td]
[td]<https://github.com/danbooru/danbooru/blob/master/app/policies/forum_post_policy.rb>[/td]
[/tr]
[/tbody]
[/table]