AMampache
Songs
Search

Search for media entities using rule triplets

Changed on

Provide operator plus one or more rule triplets. At minimum, rule_1, rule_1_operator, rule_1_input are required. Additional rules may be supplied as rule_2, rule_2_operator, rule_2_input, etc. A rule may also carry rule_<n>group (int) to combine it with other rules sharing that id under group<id>_operator (and/or), instead of the top-level operator -- exactly two levels, group ids are not nested.

get/songs/search

Request

  • Base URL
    https://develop.ampache.dev/rest/8/json
  • URL
    https://develop.ampache.dev/rest/8/json/songs/search
  • Auth
    • HTTP bearer
    • or API key in header auth
    • or API key in query parameter auth

Query parameters

operator'and' | 'or' required

and, or (whether to match one rule or all)

randomboolean

0, 1 (random order of results; default to 0)

offsetinteger

Return results starting from this index position

limitinteger

Maximum number of results to return

rule_1string required

Rule field/key for rule 1

rule_1_operatorstring required

Operator for rule 1

rule_1_inputstring required

Input value for rule 1

rule_2string

Rule field/key for rule 2

rule_2_operatorstring

Operator for rule 2

rule_2_inputstring

Input value for rule 2

rule_3string

Rule field/key for rule 3

rule_3_operatorstring

Operator for rule 3

rule_3_inputstring

Input value for rule 3

rule_1_groupinteger

Group id for rule 1, to combine it under a group_<id>_operator

rule_2_groupinteger

Group id for rule 2, to combine it under a group_<id>_operator

rule_3_groupinteger

Group id for rule 3, to combine it under a group_<id>_operator

group_1_operator'and' | 'or'

and, or (operator joining the rules assigned to group 1)

Response

Search results

total_countinteger required
md5string required

Changes

  • 7d47103d7ec9Revision changes
    • info

      added the new optional query request parameter group_1_operator

    • info

      added the new optional query request parameter rule_1_group

    • info

      added the new optional query request parameter rule_2_group

    • info

      added the new optional query request parameter rule_3_group

  • 535feee32afbRevision changes
    • info

      added the required property // to the response with the status