api:wiki pages
Table of Contents
- 01. Record field format
- 02. Derived field format
- 03. Associated attributes
- 04. Index
- 05. Show
- 06. Create
- 07. Update
- 08. Delete
- 09. Revert
- 10. See also
The following includes the details of how to interface with the wiki page records through the API.
Record field format
| Name | Type | Details |
|---|---|---|
id | integer | >0 |
title | string | |
body | string | |
other_names | array | strings |
is_deleted | boolean | |
locked | boolean | |
created_at | timestamp | |
updated_at | timestamp |
Derived field format
These are values which are not part of the actual record, but instead are derived from calculations and record lookups on the fly.
| Name | Type | Details | Notes |
|---|---|---|---|
category_name | string | [0,1,3,4,5,null] | It is the category of the associated tag if it exists, otherwise it is null. |
Associated attributes
| Name | Type | Number | Availability | Details |
|---|---|---|---|---|
tag | tag | single | optional | |
artist | artist | single | optional | |
dtext_links | dtext link | multiple | optional |
Nomenclature
- Plural form: "wiki_pages"
- Used in the URL pathname
- Singular form: "wiki_page"
- Used for write parameters (Help:API Write Requests)
- Versions: API:Wiki page versions
Index
| HTTP Method | GET |
| Base URL | /wiki_pages.json |
| Type | read request |
| Description | The default order is updated at descending. |
Search attributes
All of the following are standard attributes with all of their available formats and qualifiers.
- Number syntax
idcreated_atupdated_at- Text syntax
titlebody- Array syntax
other_names- Boolean syntax
is_deletedis_locked- Chaining syntax
tagartistdtext_links
Special search parameters
body_matches- Case-insensitive wildcard searching on the body text field.title_normalize- Normalized case-insensitive wildcard searching on the title text field.other_names_match- Case-insensitive wildcard search on any of the other names.linked_to- All wiki pages that link to the given wiki title.not_linked_to- All wiki pages that do not link to the given wiki title.hide_deleted- Hides all deleted wikis (boolean syntax).- Shortcut for
search[is_deleted]=false other_names_present- Shows wikis based on the presence of other names (boolean syntax).- Shortcut for
search[other_name_count]=>0(TRUE) andsearch[other_name_count]=0(FALSE) order- Sets the order of results.title- Alphabetical order on the title.post_count- Orders by post count.
Show
| HTTP Method | GET |
| Base URL | /wiki_pages/$id.json |
| Type | read request |
| Description | $id is the wiki page ID or title. |
Create
| HTTP Method | POST |
| Base URL | /wiki_pages.json |
| Type | write request |
Create parameters
- Required:
title- Optional
bodyother_names- Uses URL array parameter format.other_names_string- Space delimited list of post IDs.is_deletedis_locked
Update
| HTTP Method | PUT/PATCH |
| Base URL | /wiki_pages/$id.json |
| Type | write request |
| Description | $id is the wiki page ID or title. |
Update parameters
Accepts the same parameters as the create wiki page action. All parameters are optional.
Delete
| HTTP Method | DELETE |
| Base URL | /wiki_pages/$id.json |
| Type | write request |
| Description | $id is the wiki page ID or title. |
Note: This action can also be accomplished using the update wiki page action by setting is_deleted to true.
Revert
| HTTP Method | PUT |
| Base URL | /wiki_pages/$id/revert.json |
| Type | write request |
| Description | $id is the wiki page ID or title. |
Revert parameters
- Required:
- version_id - The wiki page version ID to revert to.