Danbooru
Login Posts Comments Notes Artists Tags Pools Wiki Forum More ยป
Search Changes Help | Posts (0) History
  • Help
guro
scat
furry -rating:g

Recent Changes (all)

  • caliby cat
  • yamamon 0
  • cat
  • uni create
  • list of honkai: star rail characters
  • european wildcat
  • tortico cat
  • torbie cat
  • abyssinian cat
  • russian blue cat
  • russian blue
  • tonkinese
  • singapura
  • murasaki mai
  • kisoe mitsuki
  • japanese bobtail
  • skott (honkai: star rail)
  • matoba kaoru
  • aizawa kakeru
  • furry
  • red hare (fate)
  • sherlock holmes (fate)
  • bagworm (dragon quest)
  • ono no komachi (fate)
  • wolfgang amadeus mozart (fate)

Options

  • Wiki History
  • Discussions
  • What Links Here

api:bulk update requests

Table of Contents
  • 1. Record field format
  • 2. Associated attributes
  • 3. Nomenclature
  • 4. Actions
    • 4.01 Index
    • 4.02 Show
    • 4.03 Create
    • 4.04 Update
    • 4.05 Delete
    • 4.06 Approve
  • 5. See also
  • 6. External links

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

NameTypeDetails
idinteger>0
user_idinteger>0
approver_idinteger>0
forum_topic_idinteger>0
forum_post_idinteger>0
scriptstring
statusstring[pending, approved, rejected, processing, failed]
created_attimestamp
updated_attimestamp

Associated attributes

NameTypeNumberAvailabilityDetails
userusersinglerequired
approverusersingleoptional
forum_topicforum topicsinglerequired
forum_postforum postsinglerequired

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.


Index
HTTP MethodGET
Base URL/bulk_update_requests.json
Typeread request
DescriptionThe default order is ID descending
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).

Show
HTTP MethodGET
Base URL/bulk_update_requests/$id.json
Typeread request
Description$id is the bulk update request ID
Create
HTTP MethodPOST
Base URL/uploads.json
Typewrite request
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.


Update
HTTP MethodPUT/PATCH
Base URL/bulk_update_request/$id.json
Typewrite request
Description$id is the bulk update request ID
Update parameters
  • Optional:
    • script
  • Admin-only parameters:
    • forum_post_id
    • forum_topic_id

Delete
HTTP MethodDELETE
Base URL/bulk_update_request/$id.json
Typewrite request
Description$id is the bulk update request ID

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


Approve
HTTP MethodPOST
Base URL/bulk_update_request/$id/approve.json
Typewrite request
Description$id is the bulk update request ID

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.


See also

  • Help:Common URL Parameters
  • Help:API

External links

Controllerhttps://github.com/danbooru/danbooru/blob/master/app/controllers/bulk_update_requests_controller.rb
Modelhttps://github.com/danbooru/danbooru/blob/master/app/models/bulk_update_request.rb
Policyhttps://github.com/danbooru/danbooru/blob/master/app/policies/bulk_update_request_policy.rb
Terms / Privacy / Upgrade / Contact /