-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathget_fields.Rd
More file actions
63 lines (55 loc) · 2.62 KB
/
Copy pathget_fields.Rd
File metadata and controls
63 lines (55 loc) · 2.62 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/get.R
\name{get_fields}
\alias{get_fields}
\title{Get Fields}
\usage{
get_fields(
field_id = "",
offset = "",
limit = 10,
requestAllFields = TRUE,
keyToUse = awhereEnv75247$uid,
secretToUse = awhereEnv75247$secret,
tokenToUse = awhereEnv75247$token,
apiAddressToUse = awhereEnv75247$apiAddress
)
}
\arguments{
\item{field_id}{Either a field id to retrieve information for that specific field
or an empty string to retrieve information on all fields associated
with the user's aWhere API account (string - optional)}
\item{offset}{The number of objects to skip before returning objects. Used in conjunction with offset to paginate. (optional)}
\item{limit}{The number of results to include on each of page of listed fields. Used in conjunction with offset to paginate. (optional)}
\item{requestAllFields}{Causes function to execute logic to return all of a users fields using the minimum number of API calls
based on the limit parameter. If used, offset must be set to default value (optional)}
\item{keyToUse}{aWhere API key to use. For advanced use only. Most users will not need to use this parameter (optional)}
\item{secretToUse}{aWhere API secret to use. For advanced use only. Most users will not need to use this parameter (optional)}
\item{tokenToUse}{aWhere API token to use. For advanced use only. Most users will not need to use this parameter (optional)}
\item{apiAddressToUse}{Address of aWhere API to use. For advanced use only. Most users will not need to use this parameter (optional)}
}
\value{
- data.frame containing information about requested field(s)
}
\description{
\code{get_fields} calls Get Field Locations Endpoint of API
}
\details{
Fields are how you manage the locations for which you're tracking weather, agronomics,
models, and progress over growing seasons in the aWhere API. By registering a field, you create a quick way
to consistently reference locations across all of our APIs, and allow our modeling APIs
to better operate and tune to the conditions and status of each specific field.
Before using aWhere's APIs you'll need to register the field locations.
This is a one-time step. Every field has an ID that you define, plus a latitude and longitude.
Fields are universal across all of our APIs, and as you provide information about a field, some APIs
(such as agronomics and models) can leverage that detail internally to more easily and seamlessly
calculate information for you.
}
\examples{
\dontrun{get_fields('field_test')
get_fields()
}
}
\references{
https://docs.awhere.com/knowledge-base-docs/get-field-locations/
}