Edit
Table of Contents
- 01. Record field format
- 02. Associated attributes
- 03. Index
- 04. Show
- 05. Create
- 06. Update
- 07. Delete
- 08. Undelete
- 09. Revert
- 10. See also
- 11. External links
This page has details for how to interact with pool records through the API.
Record field format
| Name | Type | Details |
|---|---|---|
id | integer | >0 |
name | string | |
description | string | |
post_ids | array | integers > 0 |
category | string | [series, collection] |
is_deleted | boolean | |
is_active | boolean | unused |
created_at | timestamp | |
updated_at | timestamp |
Associated attributes
There are no available relations that can be included through the API.
Index
Returns multiple pool records.
| HTTP Method | GET |
| Base URL | /pools.json |
| Type | read request |
| Description | The default order is updated at descending. |
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
idcreated_atupdated_at- Text syntax
namedescription- Array syntax
post_ids- Boolean syntax
is_deleted- Chaining syntax
dtext_links
Special search parameters
The following are additional search fields.
name_contains- Normalized case-insensitive search with wildcards at the start and end.post_tags_match- The pools's post's tags match the given terms. Meta-tags not supported.linked_to- Pools 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- Pools that don't have dtext links to the given wiki page.- Needs the same format as
linked_to. categoryseries- Only series-type pools.collection- Only collection-type pools.
Search order
Using the search parameter order with one of the following values changes the order of the results.
name- Name descending.created_at- Created at 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 pool record.
| HTTP Method | GET |
| Base URL | /pools/$id.json |
| Type | read request |
| Description | $id is the pool ID. |
Create
Creates a single pool record.
| HTTP Method | POST |
| Base URL | /pools.json |
| Type | write request |
Create parameters
Pool parameters take the following format (see Help:API Write Requests for more info):
pool[FIELD]=VALUE
- Required:
namecategory- Can be: series, collection.- Optional
descriptionpost_ids- Uses URL array parameter format.- Example:
pool[post_ids][]=1&pool[post_ids][]=2 post_ids_string- Space delimited list of post IDs.
Update
Updates a single pool record.
| HTTP Method | PUT/PATCH |
| Base URL | /pools/$id.json |
| Type | write request |
| Description | $id is the pool ID. |
Update parameters
Accepts the same parameters as the Create action. All parameters are optional. Only Builders and above can update a deleted record.
Delete
Deletes a single pool record.
| HTTP Method | DELETE |
| Base URL | /pools/$id.json |
| Type | write request |
| Description | $id is the pool ID. |
Undelete
Undeletes a single pool record.
| HTTP Method | POST |
| Base URL | /pools/$id/undelete.json |
| Type | write request |
| Description | $id is the pool ID. |
Revert
Reverts an a pool record to a prior version.
| HTTP Method | PUT |
| Base URL | /pools/$id/revert.json |
| Type | write request |
| Description | $id is the pool ID. |
Revert parameters
- Required:
- version_id - The pool version ID to revert to.
Note: The version ID may be passed along as a URL parameter instead of in the body.
See also
External links
No posts found.