GET /api/v1/search

GET /api/beta/search

Get all rows that match the values provided for all column-name parameters used. If the value starts with a tilde ('~'), the rest of the value is treated as a regular expression to match and the matching is case insensitive. Otherwise, the column value must match the parameter value exactly.

Params

Param name Description
limit
optional

Sets an upper bound on the number of results to return. Defaults to 200.

Validations:

  • Must match regular expression /^([1-9][0-9]*|all|none)$/.

offset
optional

Set the number of rows to skip before returning matching rows.

Validations:

  • Must match regular expression /[1-9][0-9]*/.

key
optional

The API key to use for authorization.

associations_mode
optional

Set the amount of data to display about associations. Default is “full_info” for the show action and “count” for the index action.

Validations:

  • Must be one of: full_info, ids, count.

checked
optional
result_type
optional
id
optional
citation_id
optional
site_id
optional
treatment_id
optional
sitename
optional
city
optional
lat
optional
lon
optional
scientificname
optional
commonname
optional
genus
optional
species_id
optional
cultivar_id
optional
author
optional
citation_year
optional
treatment
optional
date
optional
time
optional
raw_date
optional
month
optional
year
optional
dateloc
optional
trait
optional
trait_description
optional
mean
optional
units
optional
n
optional
statname
optional
stat
optional
notes
optional
access_level
optional
cultivar
optional
entity
optional
method_name
optional

Get all information about the row with the matching id value. Information about associated rows (those reference by foreign keys) is shown as well.

Params

Param name Description
key
optional

The API key to use for authorization.

associations_mode
optional

Set the amount of data to display about associations. Default is “full_info” for the show action and “count” for the index action.

Validations:

  • Must be one of: full_info, ids, count.