View source: R/entitylist_update.R
entitylist_update | R Documentation |
entitylist_update(
pid = get_default_pid(),
did = NULL,
approval_required = FALSE,
url = get_default_url(),
un = get_default_un(),
pw = get_default_pw(),
retries = get_retries(),
odkc_version = get_default_odkc_version(),
orders = c("YmdHMS", "YmdHMSz", "Ymd HMS", "Ymd HMSz", "Ymd", "ymd"),
tz = get_default_tz()
)
pid |
The numeric ID of the project, e.g.: 2. Default: Set default See |
did |
(chr) The name of the Entity List, internally called Dataset. |
approval_required |
(lgl) The value to set approvalRequired to. If TRUE, a submission must be approved before an entity is created, if FALSE, an entity is created as soon as the submission is received by ODK Central. Default: FALSE. |
url |
The ODK Central base URL without trailing slash. Default: Set default See |
un |
The ODK Central username (an email address).
Default: |
pw |
The ODK Central password.
Default: |
retries |
The number of attempts to retrieve a web resource. This parameter is given to Default: 3. |
odkc_version |
The ODK Central version as a semantic version string
(year.minor.patch), e.g. "2023.5.1". The version is shown on ODK Central's
version page Default: Set default See |
orders |
(vector of character) Orders of datetime elements for lubridate. Default:
|
tz |
A timezone to convert dates and times to. Read |
You can only update approvalRequired
using this endpoint.
The approvalRequired flag controls the Entity creation flow;
if it is true then the Submission must be approved before an Entity can be
created from it and if it is false then an Entity is created as soon as the
Submission is received by the ODK Central.
By default approvalRequired
is false for the Entity Lists created after
v2023.3. Entity Lists created prior to that will have approvalRequired set to
true.
An Entity List is a named collection of Entities that have the same properties. An Entity List can be linked to Forms as Attachments. This will make it available to clients as an automatically-updating CSV.
This function is supported from ODK Central v2022.3 and will warn if the given odkc_version is lower.
A list of lists following the exact format and naming of the API
response for entitylist_detail
.
Since this nested list is so deeply nested and irregularly shaped
it is not trivial to rectangle the result into a tibble.
https://docs.getodk.org/central-api-dataset-management/#datasets
## Not run:
# See vignette("setup") for setup and authentication options
# ruODK::ru_setup(svc = "....svc", un = "me@email.com", pw = "...")
pid <- get_default_pid()
ds <- entitylist_list(pid = pid)
did <- ds$name[1]
ds1 <- entitylist_detail(pid = pid, did = did)
ds1$approvalRequired # FALSE
ds2 <- entitylist_update(pid = pid, did = did, approval_required = TRUE)
ds2$approvalRequired # TRUE
ds3 <- entitylist_update(pid = pid, did = did, approval_required = FALSE)
ds3$approvalRequired # FALSE
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.