Miyuu's Image Board

api:pools

Table of Contents* 01. "Record field format":#dtext-record
* 02. "Associated attributes":#dtext-associations
* 03. "Nomenclature":#dtext-nomenclature
* 04. "Index":#dtext-index
* 05. "Show":#dtext-show
* 06. "Create":#dtext-create
* 07. "Update":#dtext-update
* 08. "Delete":#dtext-delete
* 09. "Undelete":#dtext-undelete
* 10. "Revert":#dtext-revert
* 11. "See also":#dtext-see-also
* 12. "External links":#dtext-external-links

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


h4#record. Record field format


[table]

[thead]

[tr]

[th]Name[/th]

[th]Type[/th]

[th]Details[/th]

[/tr]

[/thead]

[tbody]

[tr]

[td]

id
[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]
name
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
description
[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]
post_ids
[/td]

[td]array[/td]

[td]integers > 0[/td]

[/tr]

[tr]

[td]
category
[/td]

[td]string[/td]

[td][series, collection][/td]

[/tr]

[tr]

[td]
is_deleted
[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]
is_active
[/td]

[td]boolean[/td]

[td]unused[/td]

[/tr]

[tr]

[td]
created_at
[/td]

[td]timestamp[/td]

[td][/td]

[/tr]

[tr]

[td]
updated_at
[/td]

[td]timestamp[/td]

[td][/td]

[/tr]

[/tbody]

[/table]


h4#associations. Associated attributes


None.


h4#nomenclature. Nomenclature


* Plural form: "pools"

** Used in the URL pathname

* Singular form: "pool"

** Used for write parameters (Help:API Write Requests)

* Versions: API:Pool versions


h4#index. Index


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/pools.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]The default order is updated at descending.[/td]

[/tr]

[/tbody]

[/table]


h5#search-attributes. 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


h5#special-search-parameters. 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.


h4#show. Show


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/pools/$id.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]
$id
is the pool ID.[/td]

[/tr]

[/tbody]

[/table]


h4#create. Create


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/pools.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[/tbody]

[/table]


h5#create-parameters. 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


h4#update. Update


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]PUT/PATCH[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/pools/$id.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]
$id
is the pool ID.[/td]

[/tr]

[/tbody]

[/table]


h5#update-parameters. Update parameters


Accepts the "same parameters":[#dtext-create-parameters] as the "create pool action":[#dtext-create]. All parameters are optional.


h4#delete. Delete


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]DELETE[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/pools/$id.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]
$id
is the pool ID.[/td]

[/tr]

[/tbody]

[/table]


Note: This action can also be accomplished using the "update pool action":[#dtext-update] by setting 

is_deleted
to true.


h4#undelete. Undelete


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/pools/$id/undelete.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]
$id
is the pool ID.[/td]

[/tr]

[/tbody]

[/table]


Note: This action can also be accomplished using the "update pool action":[#dtext-update] by setting 

is_deleted
to false.


h4#revert. Revert


[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]PUT[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/pools/$id/revert.json
[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]
$id
is the pool ID.[/td]

[/tr]

[/tbody]

[/table]


h5#revert-parameters. Revert parameters


* Required:

** version_id - The pool version ID to revert to.


h4#see-also. See also


* Help:Common URL Parameters

* Help:API


h4#external-links. External links


[table]

[tbody]

[tr]

[td]Controller[/td]

[td][/td]

[td][/td]

[/tr]

[tr]

[td]Model[/td]

[td][/td]

[/tr]

[tr]

[td]Policy[/td]

[td][/td]

[/tr]

[/tbody]

[/table]

Revision 2 by Anonymous at 2025-04-19 08:57:59.268618