Summarize all Form Assignments of one Project.

Usage

form_assignment_list(
  pid = get_default_pid(),
  url = get_default_url(),
  un = get_default_un(),
  pw = get_default_pw(),
  retries = get_retries()
)

Arguments

pid

The numeric ID of the project, e.g.: 2.

Default: get_default_pid.

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

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

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 per Form Assignment and the columns actor_id, xml_form_id and role_id.

Details

This returns a summary of all Form-specific Assignments within the Project in one transactional request. Each Assignment carries the xmlFormId of the Form it is attached to, as well as the actor_id/role_id pair.

See also

https://docs.getodk.org/central-api-project-management/#seeing-all-form-assignments-within-a-project

Other user-management: app_user_create(), app_user_delete(), app_user_list(), assignment_actors(), assignment_grant(), assignment_list(), assignment_revoke(), project_assignment_list(), role_detail(), role_list(), user_create(), user_delete(), user_detail(), user_list(), user_preference_project_delete(), user_preference_project_set(), user_preference_site_delete(), user_preference_site_set(), user_reset_password(), user_update(), user_update_password()

Examples

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

al <- form_assignment_list()

al |> knitr::kable()
} # }