-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathupdate_field.Rd
More file actions
56 lines (49 loc) · 2.4 KB
/
Copy pathupdate_field.Rd
File metadata and controls
56 lines (49 loc) · 2.4 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/update.R
\name{update_field}
\alias{update_field}
\title{Update Field}
\usage{
update_field(
field_id,
variable_update,
value_update,
keyToUse = awhereEnv75247$uid,
secretToUse = awhereEnv75247$secret,
tokenToUse = awhereEnv75247$token,
apiAddressToUse = awhereEnv75247$apiAddress
)
}
\arguments{
\item{field_id}{the unique field ID for the field you want to update (character string) (required)}
\item{variable_update}{the variable that needs to be updated, either "farmId", "name", or "acres"
(character string) (required)}
\item{value_update}{the new value for variable_update, to replace the existing value. The existing
value can be found using get_fields("field_id") (character string) (required)}
\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{
- A message confirming the changes have been made
}
\description{
\code{update_field} To update details (Farm ID or FieldName) of a particular location in the aWhere API.
}
\details{
Fields are the easiest way to manage locations in the aWhere APIs, providing an easy reference
for tracking weather, agronomics, models, and progress over growing seasons. Once a field is
registered, plantings can also be registered for that field with specific information about the
crop planted at that location, the date of planting, and other optional information.
Occasionally, you may need to update the details of your field. At this time, only the farm ID,
field Name, and number of acres can be updated using this function. Field details can only be
updated one variable at a time, for one field at a time. If you need to update multiple fields or
multiple variables associated with a field, please pass commands sequentially.
}
\examples{
\dontrun{update_field(field_id = 'field_test',variable_update = 'farmId', value_update = 'This is my territory')}
}
\references{
https://docs.awhere.com/knowledge-base-docs/update-a-field-location/
}