api:pools

The following includes the details of how to interface with the pool records through the API.

Record field format

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

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.
• category
• series - 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

Create

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

Update parameters

Accepts the same parameters as the create pool action. All parameters are optional.

Delete

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

Undelete

Note: This action can also be accomplished using the update pool action by setting is_deleted to false.

Revert

Revert parameters

• Required:
• version_id - The pool version ID to revert to.

See also

• Help:Common URL Parameters
• Help:API