Edit
Table of Contents
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
Name | Type | Details |
---|---|---|
id | integer | >0 |
user_id | integer | >0 |
approver_id | integer | >0 |
forum_topic_id | integer | >0 |
forum_post_id | integer | >0 |
script | string | |
status | string | [pending, approved, rejected, processing, failed] |
created_at | timestamp | |
updated_at | timestamp |
Associated attributes
Name | Type | Number | Availability | Details |
---|---|---|---|---|
user | user | single | required | |
approver | user | single | optional | |
forum_topic | forum topic | single | required | |
forum_post | forum post | single | required |
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 Method | GET |
Base URL | /bulk_update_requests.json |
Type | read request |
Description | The 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 Method | GET |
Base URL | /bulk_update_requests/$id.json |
Type | read request |
Description | $id is the bulk update request ID |
Create
HTTP Method | POST |
Base URL | /uploads.json |
Type | write 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 Method | PUT/PATCH |
Base URL | /bulk_update_request/$id.json |
Type | write request |
Description | $id is the bulk update request ID |
Update parameters
- Optional:
script
- Admin-only parameters:
forum_post_id
forum_topic_id
Delete
HTTP Method | DELETE |
Base URL | /bulk_update_request/$id.json |
Type | write 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 Method | POST |
Base URL | /bulk_update_request/$id/approve.json |
Type | write 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
External links
No posts found.