api:pools
The following includes the details of how to interface with the pool records through the API.
Record field format
- id: integer, > 0
- name: string
- description: string
- post_ids: array, integers > 0
- category: string, includes ["series", "collection"]
- is_deleted: boolean
- is_active: boolean (deprecated)
- created_at: timestamp
- updated_at: timestamp
Associated attributes
None.
Endpoints
Endpoint refers to the various actions that can be done with pool records.
Index
The base URL is GET /pools.json
Search parameter format
All search parameters use URL hash format where "search" is the base object.
Example: search[PARAMETER]
Search attributes
All of the following are standard attributes with all of their available formats and qualifiers.
- Number syntax
id
created_at
updated_at
- Text syntax
name
description
- 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. -
series
- Only series-type pools. -
collection
- Only collection-type pools. -
order
- Uses alternate orderings. -
name
- Alphabetic order by name. -
created_at
- Orders by creation time. -
post_count
- Orders by post count.
Note: The default order is updated at descending.
Show
The base URL is GET /pools/$id.json where $id is the pool ID.
Create
The base URL is POST /pools.json
Create parameter format
All create parameters use URL hash format where "pool" is the base object.
Example: pool[PARAMETER]
Create parameters
- Required:
name
-
category
- Can be: series, collection. - Optional
description
-
post_ids
- Uses URL array parameter format. -
post_ids_string
- Space delimited list of post IDs. is_deleted
Update
The base URL is PUT /pools/$id.json where $id is the pool ID.
Update parameters
Accepts the same parameters as the create pool action. All parameters are optional.
Delete
The base URL is DELETE /pools/$id.json where $id is the pools ID.
Note: This action can also be accomplished using the update pool action by setting is_deleted
to true.
Undelete
The base URL is POST /pools/$id/undelete.json where $id is the pool id.
Note: This action can also be accomplished using the update pool action by setting is_deleted
to false.
Revert
The base URL is PUT /pools/$id/revert.json where $id is the pool ID.
- Required:
- version_id - The pool version ID to revert to.