Table of Contents

• 1. Record field format
• 2. Associated attributes
• 3. Nomenclature
• 4. Index
• 5. Show
• 6. Delete
• 7. See also

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

Record field format

Name	Type	Details
id	integer	>0
antecedent_name	string
consequent_name	string
status	string	includes [active, deleted, retired]
reason	string	unused
forum_topic_id	integer	>0 or null
forum_post_id	integer	>0 or null
creator_id	integer	>0
approver_id	integer	>0 or null
created_at	timestamp
updated_at	timestamp

Associated attributes

Name	Type	Number	Availability	Details
creator	user	single	required	User that created the alias.
approver	user	single	optional	User that approved the alias.
forum_topic	forum topic	single	optional	Forum topic where the aliasas discussed.
forum_post	forum post	single	optional	Forum post which started the alias discussion.
antecedent_tag	tag	single	required	Tag of the antecedent.
consequent_tag	tag	single	required	Tag of the consequent.
antecedent_wiki	wiki page	single	optional	Wiki page of the antecedent.
consequent_wiki	wiki page	single	optional	Wiki page of the consequent.

Nomenclature

• Plural form: "tag_aliases"
• Used in the URL pathname
• Singular form: "tag_alias"
• Used for write parameters (Help:API Write Requests)
• Versions: none

Index

HTTP Method	GET or POST*
Base URL	/tag_aliases.json
Type	read request
Description	The default order is ID descending. * Accepts POST under certain circumstances. See Help:API read requests.

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
• antecedent_name
• consequent_name
• User syntax
• creator
• approver
• Chaining syntax
• forum_topic
• forum_post

Special search parameters

• name_matches - Case-insensitive wildcard search on the antecedent name or consequent name fields.
• status - Case-insensitive search on the status field.
• category - Searches on the category of the consequent tag, with support for multiple categories being space-delimited.

Search order

Using the search parameter order with one of the following values changes the order of the results.

• created_at - Orders by created_at descending.
• updated_at - Orders by updated_at descending.
• name - Alphabetical order on the antecedent, then alphabetical order on the consequent.
• tag_count - Orders by post count of the consequent tag, then alphabetical order on the antecedent, then alphabetical order on the consequent.
• custom - See here for more info.

Show

HTTP Method	GET or POST*
Base URL	/tag_aliases/$id.json
Type	read request
Description	$id is the forum post ID. * Accepts POST under certain circumstances. See Help:API read requests.

Delete

HTTP Method	DELETE
Base URL	/tag_aliases/$id.json
Type	write request
Description	$id is the forum post ID. Restricted to Admin+.

See also

• Help:Common URL Parameters
• Help:API

External links

Controller	https://github.com/danbooru/danbooru/blob/master/app/controllers/tag_aliases_controller.rb
Model	https://github.com/danbooru/danbooru/blob/master/app/models/tag_relationship.rb https://github.com/danbooru/danbooru/blob/master/app/models/tag_alias.rb
Policy	https://github.com/danbooru/danbooru/blob/master/app/policies/tag_alias_policy.rb

View wiki