Edit
Table of Contents
- 01. Record field format
- 02. Associated attributes
- 03. Nomenclature
- 04. Index
- 05. Show
- 06. Create
- 07. Update
- 08. Delete
- 09. Undelete
- 10. Revert
- 11. See also
The following includes the details of how to interface with the 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
None.
Nomenclature
- Plural form: "pools"
- Used in the URL pathname
- Singular form: "pool"
- Used for write parameters (Help:API Write Requests)
- Versions: API:Pool versions
Index
| HTTP Method | GET or POST* |
| Base URL | /pools.json |
| Type | read request |
| Description | The default order is updated at descending. * Accepts POST under certain circumstances. See Help:API read requests. |
Search attributes
All of the following are standard attributes with all of their available formats and qualifiers.
- Number syntax
idcreated_atupdated_at- Text syntax
namedescription- Array syntax
post_ids- Boolean syntax
is_deleted
Special search parameters
name_matches- Normalized case-insensitive wildcard searching on the name text field.description_matches- Case-insensitive wildcard searching on the description text field.post_tags_match- The pools's post's tags match the given terms. Meta-tags not supported.categoryseries- Only series-type pools.collection- Only collection-type pools.order- Sets the order of the results.name- Alphabetic order by name.created_at- Orders by creation time.post_count- Orders by post count.
Show
| HTTP Method | GET or POST* |
| Base URL | /pools/$id.json |
| Type | read request |
| Description | $id is the pool ID.* Accepts POST under certain circumstances. See Help:API read requests. |
Create
| HTTP Method | POST |
| Base URL | /pools.json |
| Type | write request |
| Description |
Create parameters
- Required:
namecategory- Can be: series, collection.- Optional
descriptionpost_ids- Uses URL array parameter format.post_ids_string- Space delimited list of post IDs.is_deleted
Update
| 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 pool action. All parameters are optional.
Delete
| HTTP Method | DELETE |
| Base URL | /pools/$id.json |
| Type | write request |
| Description | $id is the pool ID. |
Note: This action can also be accomplished using the update pool action by setting is_deleted to true.
Undelete
| HTTP Method | POST |
| Base URL | /pools/$id/undelete.json |
| Type | write request |
| Description | $id is the pool ID. |
Note: This action can also be accomplished using the update pool action by setting is_deleted to false.
Revert
| 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.
See also
No posts found.
1