Fields the telemetry API accepts on a write

The columns each endpoint takes, what it requires, and the limits it enforces. telem_validate() checks against this, and the create functions call that before sending, so a bad column fails locally with the whole list rather than returning a 422 partway through a batch.

Usage

telem_fields(resource = NULL)

Arguments

resource

Character. One of "individuals", "devices", "deployments", "captures", "events" or "positions". NULL returns every resource.

Value

A tibble with one row per field: resource, field, presence, na_ok, type, enum, max_len, min_val, max_val.

Examples

telem_fields("devices")
#> # A tibble: 9 × 9
#>   resource field         presence na_ok type      enum   max_len min_val max_val
#>   <chr>    <chr>         <chr>    <lgl> <chr>     <chr>    <int>   <dbl>   <dbl>
#> 1 devices  serial_number required FALSE character NA          50      NA      NA
#> 2 devices  state         present  TRUE  character telem…      25      NA      NA
#> 3 devices  blueprint_id  optional TRUE  integer   NA          NA      NA      NA
#> 4 devices  price         optional TRUE  numeric   NA          NA       0      NA
#> 5 devices  purchased_at  optional TRUE  date      NA          NA      NA      NA
#> 6 devices  retired_at    optional TRUE  date      NA          NA      NA      NA
#> 7 devices  frequency     optional TRUE  numeric   NA          NA       0      NA
#> 8 devices  notes         optional TRUE  character NA          NA      NA      NA
#> 9 devices  project_id    optional TRUE  integer   NA          NA      NA      NA