api:artists

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

Record field format

Associated attributes

Nomenclature

• Plural form: "artists"
• Used in the URL pathname
• Singular form: "artist"
• Used for write parameters (Help:API Write Requests)
• Versions: API:Artist versions

Index

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
• group_name
• Boolean syntax
• is_deleted
• is_banned
• Array syntax
• other_names

Special search parameters

• any_other_name_like - Search for artists that have an other name matching this value. Supports wildcards.
• any_name_matches - Search for artists that have a matching name, group name, or other name. Supports wildcards and regexes.
• url_matches - Search for artists with a matching URL.
• Does a regex match when the query starts and ends with a forward slash "/".
• Regexes must follow the Ruby's format.
• Does a wildcard match when there are asterisks "*" present.
• Uses the artist URL finder when the value is prefaced by http:// or https://
• This does a recursive search on URLs stripping the pathname one level at a time to search for matches.
• It will keep searching until it finds an exact match or 10 similar entries.
• Otherwise it does a wildcard search with wildcard placed at the start and end.
• any_name_or_url_matches - Searches for the artist by name or URL.
• Does a URL search if the value is prefaced by http:// or https://
• Does a name search otherwise.
• order - Sets the order of the results.
• name
• updated_at
• post_count

Show

Create

Create parameters

• Required:
• name- The artist tag name.
• Must be tag format (API:tags).
• Optional
• group_name - The name of the group this artist belongs to.
• other_names - List of alternative names for this artist.
• Space delimited. Replace spaces within names with underscores.
• url_string - List of URLs associated with this artist
• Whitespace or newline delimited.
• is_deleted - Set the artist entry as deleted or not.

Update

Update parameters

Accepts the same parameters as the create artist action. All parameters are optional.

Delete

Note: The action can be accomplished using the update artist action by setting is_deleted to true.

Banned

Revert

Revert parameters

• Required:
• version_id - The artist version ID to revert to.

Ban

Unban

See also

• Help:Common URL Parameters
• Help:API

External links