Miyuu's Image Board

Table of Contents

•1. Record field format
•2. Associated attributes
•3. Nomenclature
•4. Actions
•5. See also
•6. External links
[/ul]

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

Note: Only upload records created by oneself are visible, unless you are an Admin (Help:Users).

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]

user_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

approver_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

forum_topic_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

forum_post_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

script

[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]

status

[/td]

[td]string[/td]

[td]

[pending, approved, rejected, processing, failed]

[/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]

Associated attributes

[table]

[thead]

[tr]

[th]Name[/th]

[th]Type[/th]

[th]Number[/th]

[th]Availability[/th]

[th]Details[/th]

[/tr]

[/thead]

[tbody]

[tr]

[td]

user

[/td]

[td]user[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[tr]

[td]

approver

[/td]

[td]user[/td]

[td]single[/td]

[td]optional[/td]

[td][/td]

[/tr]

[tr]

[td]

forum_topic

[/td]

[td]forum topic[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[tr]

[td]

forum_post

[/td]

[td]forum post[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[/tbody]

[/table]

Nomenclature

• Plural form: "bulk_update_requests"

•• Used in the URL pathname

• Singular form: "bulk_update_request"

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

• Versions: none

Actions

These are the various actions that can be done with bulk update request records.

[hr]

Index

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/bulk_update_requests.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]The default order is ID descending[/td]

[/tr]

[/tbody]

[/table]

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

••

script

• User syntax

••

user

••

approver

• Chaining syntax

••

forum_topic

••

forum_post

••

tags

Special search parameters

• status

  - The status of the bulk update request (separated by commas).

[hr]

Show

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/bulk_update_requests/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the bulk update request ID[/td]

[/tr]

[/tbody]

[/table]

Create

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/uploads.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[/tbody]

[/table]

Create parameters

• Mandatory:

••

script

••

title

••

reason

••

forum_topic_id

Note:If forum topic ID is present, then title will be ignored. If forum topic ID is absent, then title will be used to create a new forum topic. The reason will be used to create a new forum post.

[hr]

Update

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]PUT/PATCH[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/bulk_update_request/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the bulk update request ID[/td]

[/tr]

[/tbody]

[/table]

Update parameters

• Optional:

••

script

• Admin-only parameters:

••

forum_post_id

••

forum_topic_id

[hr]

Delete

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]DELETE[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/bulk_update_request/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the bulk update request ID[/td]

[/tr]

[/tbody]

[/table]

Note: Only the user that created the bulk update request or an Admin may delete it.

[hr]

Approve

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/bulk_update_request/$id/approve.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the bulk update request ID[/td]

[/tr]

[/tbody]

[/table]

Note: Builders and above can approve bulk update requests that:

• Rename or alias
• Only artist tags
• Post count must be less than 200

Otherwise, only an admin may approve that request.

[hr]

See also

• Help:Common URL Parameters
• Help:API

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]