api:post appeals
The following includes the details of how to interface with the post appeal records through the API.
Record field format
Name | Type | Details |
---|---|---|
id |
integer | >0 |
creator_id |
integer | >0 |
post_id |
integer | >0 |
reason |
string | |
created_at |
timestamp | |
updated_at |
timestamp |
Associated attributes
Name | Type | Number | Availability | Details |
---|---|---|---|---|
creator |
user | single | required | |
post |
post | single | required |
Nomenclature
- Plural form: "post appeals"
- Used in the URL pathname
- Singular form: "post appeal"
- Used for write parameters (Help:API Write Requests)
- Versions: none
Actions
These are the various actions that can be done with post appeal records.
Index
The base URL is GET /post_appeals.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
- User syntax
creator
Special search parameters
-
post_tags_match
- The post query of the search term matches the post of the post appeal. -
reason_matches
- Case-insensitive wildcard search on the reason field. -
is_resolved
- Is the post active or not? - true: Post is unflagged and undeleted.
- false: Post is flagged or deleted.
Show
The base URL is GET /post_appeals/$id.json where $id is the post appeal ID.
Create
The base URL is POST /post_appeals.json
Create parameters
- Required:
post_id
reason