api:post flags
The following includes the details of how to interface with the post flag records through the API.
Record field format
Name | Type | Details |
---|---|---|
id |
integer | >0 |
creator_id |
integer | >0, limited to Moderator+ or the flag creator |
post_id |
integer | >0 |
reason |
string | |
category |
string | includes [normal, unapproved, rejected] |
is_resolved |
boolean | |
created_at |
timestamp | |
updated_at |
timestamp |
Associated attributes
Name | Type | Number | Availability | Details |
---|---|---|---|---|
post |
post | single | required |
Nomenclature
- Plural form: "post flags"
- Used in the URL pathname
- Singular form: "post flag"
- Used for write parameters (Help:API Write Requests)
- Versions: none
Actions
These are the various actions that can be done with post flag records.
Index
The base URL is GET /post_flags.json
Note: The default order is ID descending.
Search attributes
All of the following are standard attributes with all of their available formats and qualifiers.
- Number syntax
id
post_id
created_at
updated_at
- Text syntax
reason
- Boolean syntax
is_resolved
Special search parameters
-
post_tags_match
- The post query of the search term matches the post of the post flag. -
reason_matches
- Case-insensitive wildcard search on the reason field. -
creator_id
- Searches for flags by creator ID. Single ID only. -
creator_name
- Searches for flags by creator name. Single name only. -
category
- Can be: normal, unapproved, rejected, deleted.
Show
The base URL is GET /post_flags/$id.json where $id is the post flag ID.
Create
The base URL is POST /post_flags.json
Create parameters
- Required:
post_id
reason