GET /api/v1/yields

GET /api/beta/yields

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.

id
optional
citation_id
optional

Citation in which data originally reported.

site_id
optional

Site at which crop was harvested.

specie_id
optional

Species for which yield was measured.

treatment_id
optional

Experimental treatment identification. Required, can indicate observational study.

cultivar_id
optional

Cultivar information, if any.

date
optional

Date on which crop was harvested.

dateloc
optional

Level of confidence in harvest date. See documentation.

statname
optional

Name of reported statistic.

stat
optional

Value of reported statistic.

mean
optional

Mean yield reported.

n
optional

Number of replicates used to estimate mean and statistical summary.

notes
optional
created_at
optional
updated_at
optional
user_id
optional

ID of user who entered data.

checked
optional

accepts values [-1, 0, 1]. 0 is default, and means that data have not been checked. 1 indicates that the data have been checked and are correct, -1 indicates that data have been checked and found to be incorrect or suspicious, e.g. outside of the acceptab

access_level
optional

Level of access required to view data.

method_id
optional
entity_id
optional
date_year
optional
date_month
optional
date_day
optional

GET /api/v1/yields/:id

GET /api/beta/yields/:id

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.