Package index

Read

Query records. Reads return every matching record by default; pass pages to page deliberately.

telem_read_individuals()

List individuals

telem_read_devices()

List devices

telem_read_deployments()

List deployments

telem_read_captures()

List captures

telem_read_events()

List events

telem_read_positions()

List GPS positions

telem_read_blueprints()

List blueprints

telem_read_sensor_deployments()

List sensor deployments

telem_read_groups()

List groups

telem_read_group_individuals()

List group memberships

telem_read_diagnoses()

List diagnoses

telem_read_procedures()

List procedures

telem_read_samples()

List samples

telem_reading

Shared documentation for the read functions

Create

Add records in batches.

telem_create_individuals()

Create individuals in the telemetry API

telem_create_devices()

Create devices in the telemetry API

telem_create_deployments()

Create deployments in the telemetry API

telem_create_captures()

Create captures in the telemetry API

telem_create_events()

Create events in the telemetry API

telem_create_positions()

Push GPS positions to the telemetry API

telem_create_blueprints()

Create blueprints in the telemetry API

telem_create_sensor_deployments()

Create sensor deployments in the telemetry API

telem_create_groups()

Create groups of animals

telem_create_group_individuals()

Put animals in groups

telem_create_diagnoses()

Record diagnoses against animals

telem_create_procedures()

Record procedures carried out on animals

telem_create_samples()

Record samples taken from animals

Uploading positions held locally

Most positions are collected from the manufacturer by the server. This is for the ones you have on disk.

telem_add_payload()

Build the payload column a position upload needs

Update

Change one record at a time.

telem_update_individual()

Update an individual in the telemetry API

telem_update_device()

Update a device in the telemetry API

telem_update_deployment()

Update a deployment in the telemetry API

telem_update_capture()

Update a capture in the telemetry API

telem_update_event()

Update an event in the telemetry API

telem_update_blueprint()

Update a blueprint in the telemetry API

telem_update_sensor_deployment()

Update a sensor deployment in the telemetry API

telem_update_group()

Update a group

telem_update_diagnosis()

Update a diagnosis

telem_update_procedure()

Update a procedure

telem_update_sample()

Update a sample

Delete

Remove one record. The API requires an admin role for these, so a caller without it gets a 403 rather than a deletion.

telem_delete_individual()

Delete an individual from the telemetry API

telem_delete_device()

Delete a device from the telemetry API

telem_delete_deployment()

Delete a deployment from the telemetry API

telem_delete_capture()

Delete a capture from the telemetry API

telem_delete_event()

Delete an event from the telemetry API

telem_delete_blueprint()

Delete a blueprint from the telemetry API

telem_delete_sensor_deployment()

Delete a sensor deployment from the telemetry API

telem_delete_group()

Delete a group

telem_delete_group_individual()

Remove one animal from a group

telem_delete_diagnosis()

Delete a diagnosis

telem_delete_procedure()

Delete a procedure

telem_delete_sample()

Delete a sample

Re-runnable loads

Create only the records an endpoint does not already hold, matched on columns you name. A load that stops partway can be run again without duplicating what landed the first time.

telem_create_missing()

Create only the records that are not there yet

Working with what a create returns

Batch endpoints answer with one row per submitted record, the created record inside a list-column. This gets the assigned ids back out.

build_lookup()

Map your own keys to the ids the API assigned

Known API gaps

Vocabulary that exists because the API has no field for it yet. See the function’s own notes for what changes when it does.

telem_mortality_causes()

Causes of death recorded against a mortality event

What the API accepts

The fields each endpoint takes, and a check you can run before sending. Every create runs this for you.

telem_fields()

Fields the telemetry API accepts on a write

telem_validate()

Check data against what the API accepts

Accepted values

The values the API accepts for its enumerated fields, so payloads can be built and validated before they are sent.

telem_event_types() telem_event_statuses() telem_event_sources() telem_device_states() telem_sample_states() telem_blueprint_types() telem_capture_methods() telem_deployment_statuses() telem_fates() telem_sexes() telem_device_manufacturers()

Values the telemetry API accepts for enumerated fields