delete_options_in_list: Delete all or some options in an option list

In arestrom/iformr: A set of tools to leverage the iFormBuilder API

Description

Sends a request to the iFormBuilder API to delete a list of option elements. The elements to delete are specified by a .json list of element ids. Sort order will automatically be reassigned after deleting specified elements.

Usage

delete_options_in_list(
  server_name,
  profile_id,
  optionlist_id,
  fields = "fields",
  id_values,
  limit = 1000,
  offset = 0,
  access_token
)

Arguments

server_name	String of the iFormBuilder server name
profile_id	The id number of your profile
optionlist_id	The id number for the option list
fields	Placeholder for fields to delete, not yet implemented
id_values	A .json list of ids for elements to delete
limit	The maximum number of option elements to delete
offset	Skips the offset number of options before beginning to delete
access_token	Access token produced by get_iform_access_token

Value

A vector of option list elements that were deleted

Examples

## Not run: 
# Define .json list of ids for elements to delete
# Replace example values below with your own
  id_values = tibble::tibble(id = c(663487010, 663487013))
  id_values_json = jsonlite::toJSON(id_values, auto_unbox = TRUE)

# Get access_token
access_token <- get_iform_access_token(
  server_name = "your_server_name",
  client_key_name = "your_client_key_name",
  client_secret_name = "your_client_secret_name")

# Delete specified elements from option list
deleted_ids <- delete_options_in_list(
  server_name = "your_server_name",
  profile_id = 123456,
  optionlist_id = your_option_list_id,
  id_values = id_values_json,
  access_token = access_token)

# Inspect the first five deleted ids
head(deleted_ids, 5)

## End(Not run)

arestrom/iformr documentation built on Nov. 25, 2021, 11:21 p.m.