Get submission audits for a list of submission instance IDs.
Source:R/submission_audit_get.R
submission_audit_get.Rd
Usage
submission_audit_get(
iid,
pid = get_default_pid(),
fid = get_default_fid(),
url = get_default_url(),
un = get_default_un(),
pw = get_default_pw(),
retries = get_retries()
)
Arguments
- iid
A list of submission instance IDs, e.g. from
submission_list$instance_id
.- pid
The numeric ID of the project, e.g.: 2.
Default:
get_default_pid
.Set default
pid
throughru_setup(pid="...")
.See
vignette("Setup", package = "ruODK")
.- fid
The alphanumeric form ID, e.g. "build_Spotlighting-0-8_1559885147".
Default:
get_default_fid
.Set default
fid
throughru_setup(fid="...")
.See
vignette("Setup", package = "ruODK")
.- url
The ODK Central base URL without trailing slash.
Default:
get_default_url
.Set default
url
throughru_setup(url="...")
.See
vignette("Setup", package = "ruODK")
.- un
The ODK Central username (an email address). Default:
get_default_un
. Set defaultun
throughru_setup(un="...")
. Seevignette("Setup", package = "ruODK")
.- pw
The ODK Central password. Default:
get_default_pw
. Set defaultpw
throughru_setup(pw="...")
. Seevignette("Setup", package = "ruODK")
.- retries
The number of attempts to retrieve a web resource.
This parameter is given to
RETRY(times = retries)
.Default: 3.
Details
Uses get_one_submission_audit
on a list of submission
instance IDs
(iid
) as returned from submission_list$instance_id
.
By giving the list of iid
to download explicitly, that list can be
modified using information not accessible to ruODK
,
e.g. iid
can be restricted to "only not already downloaded submissions".
To get the combined submission audit logs for one form
as one single, concatenated audit.csv
file, use submission_export
.
See also
https://docs.getodk.org/central-api-submission-management/#retrieving-submission-xml
Other submission-management:
attachment_list()
,
encryption_key_list()
,
submission_detail()
,
submission_export()
,
submission_get()
,
submission_list()
Examples
if (FALSE) { # \dontrun{
# Step 1: Setup ruODK with OData Service URL (has url, pid, fid)
ruODK::ru_setup(svc = "...")
# Step 2: List all submissions of form
sl <- submission_list()
# Step 3: Get submission audit logs
sa <- submission_audit_get(sl$instance_id)
} # }