GET /api/v1/treatments

GET /api/beta/treatments

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
name
optional

Name of treatment, should be easy to associate with treatment name in original study.
definition
optional

Description of treatment, e.g. levels of fertilizer applied, etc. This information may be redundant with 'levels' information recorded in Managements table.
created_at
optional
updated_at
optional
control
optional

Boolean, indicates if treatment is a control or observational (1) or experimental treatment (0).
user_id
optional