arc_form_params: Form request parameters

In arcgisutils: R-ArcGIS Bridge Utility Functions

Form request parameters

Description

ArcGIS endpoints make extensive use of form encoded data for the body of http requests. Form requests require that each element has a name and is encoded as a single string—often as json.

Usage

arc_form_params(params = list())

as_form_params(x)

Arguments

params	a named list with scalar character elements
x	for as_form_params(), a named list to convert to form parameters

Details

The arc_form_params class provides validation of form body parameters ensuring that each element is a scalar string. It uses a named list internally to store the parameters.

The helper function as_form_params() converts a named list to form parameters by automatically JSON-encoding each element using yyjsonr::write_json_str() with auto_unbox = TRUE.

Value

an object of class arc_form_params

See Also

Other geoprocessing: arc_gp_job, arc_job_status(), gp_job_from_url(), gp_params

Other geoprocessing: arc_gp_job, arc_job_status(), gp_job_from_url(), gp_params

Examples

arc_form_params(
  list(f = "json", outFields = "*", where = "1 = 1")
)

arcgisutils documentation built on March 4, 2026, 9:06 a.m.