Skip to contents

Show Form details by Form Link ID.

Source: R/form_link.R
form_link.Rd

[Experimental]

Usage

form_link(
  form_link_id,
  url = get_default_url(),
  un = get_default_un(),
  pw = get_default_pw(),
  retries = get_retries()
)

Arguments

(character) The Form Link ID, e.g. the Enketo ID of a published Form.

url

The ODK Central base URL without trailing slash.

Default: get_default_url.

Set default url through ru_setup(url="...").

See vignette("Setup", package = "ruODK").

un

The ODK Central username (an email address). Default: get_default_un. Set default un through ru_setup(un="..."). See vignette("Setup", package = "ruODK").

pw

The ODK Central password. Default: get_default_pw. Set default pw through ru_setup(pw="..."). See vignette("Setup", package = "ruODK").

retries

The number of attempts to retrieve a web resource.

This parameter is given to RETRY(times = retries).

Default: 3.

Value

A tibble with one row holding the Form's metadata as columns as per the ODK Central API docs.

Details

Returns Form metadata for the provided Form Link ID without needing the Project ID or Form ID.

See also

https://docs.getodk.org/central-api-form-management/#getting-form-details-by-formlinkid

Other form-management: form_assignment_actors(), form_assignment_grant(), form_assignment_revoke(), form_attachment_download(), form_attachment_list(), form_create(), form_dataset_diff(), form_delete(), form_detail(), form_draft_attachment_delete(), form_draft_attachment_download(), form_draft_attachment_link(), form_draft_attachment_list(), form_draft_attachment_upload(), form_draft_create(), form_draft_dataset_diff(), form_draft_delete(), form_draft_detail(), form_draft_publish(), form_draft_xlsx(), form_draft_xml(), form_list(), form_restore(), form_schema(), form_schema_ext(), form_update(), form_version_attachment_download(), form_version_attachment_list(), form_version_detail(), form_version_list(), form_version_xlsx(), form_version_xml(), form_xlsx(), form_xml(), public_link_create(), public_link_delete(), public_link_detail(), public_link_list(), public_link_update()

Examples

if (FALSE) { # \dontrun{
# See vignette("setup") for setup and authentication options
# ruODK::ru_setup(svc = "....svc", un = "me@email.com", pw = "...")

fl <- form_list()

f <- form_link(form_link_id = fl$enketo_id[[1]])

f$fid
} # }