api:wiki pages

This page has details for how to interact with wiki page records through the API.

Record field format

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.

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):

Index

Returns multiple wiki page records.

Search attributes

Search parameters take the following format (see Help:Common URL parameters for more info):

search[FIELD]=VALUE

The following are the base fields along with their associated type. Check the syntax pages for all of the available variations.

• Number syntax
• id
• created_at
• updated_at
• Text syntax
• title
• body
• Array syntax
• other_names
• Boolean syntax
• is_deleted
• is_locked
• Chaining syntax
• tag
• artist
• dtext_links

Special search parameters

The following are additional search fields.

• 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 - Wiki pages that have dtext links to the given wiki page.
• The parameter must use the same format as the wiki title.
• I.e. all lowercase and underscores instead of spaces.
• not_linked_to - Wiki pages that don't have dtext links to the given wiki page.
• Needs the same format as linked_to.
• 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) and search[other_name_count]=0 (FALSE)
• has_embedded_media - Wiki pages that have embedded media on them (Boolean syntax).

Search order

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

• title - Title descending.
• post_count - Post count descending.
• custom - Help:Common URL parameters
• In order to use this order, search[id] must also be set with a list of comma-separated IDs.

Show

Returns a single wiki page record.

Create

Creates a single wiki page record.

Create parameters

Pool parameters take the following format (see Help:API Write Requests for more info):

wiki_page[FIELD]=VALUE

• Required:
• title
• Optional
• body
• other_names - Uses URL array parameter format.
• Example: wiki_page[other_names][]=blah&wiki_page[other_names][]=foo
• other_names_string - Space delimited list of post IDs.
• is_deleted
• is_locked - Only Builder users and higher.

Update

Updates a single wiki page record.

Update parameters

Accepts the same parameters as the Create action. All parameters are optional.

Delete

Deletes a single wiki page record.

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

Revert

Reverts a single artist record to a prior version.

Revert parameters

• Required:
• version_id - The wiki page version ID to revert to.

Note: The version ID may be passed along as a URL parameter instead of in the body.

See also

• API:Wiki page versions
• Help:Common URL Parameters
• Help:API

External links