agents_families: Agents - families

In ropenscilabs/aspacer: Client for the ArchiveSpace API

Description

Agents - families

Usage

agents_families(id = NULL, all_ids = FALSE, page = 1, limit = 10,
  parse = TRUE, ...)

Arguments

id	(integer) a single family agent identifier. optional
all_ids	(logical) Return a list of all object ids. Not sure this does anything? Default: FALSE
page	(character) page number (default: 1), optional
limit	(character) records to return (default: 10, minimum: 10), optional
parse	(logical) Attempt to parse to data.frame's if possible. Default: TRUE
...	Curl options passed on to GET or POST

Value

either a data.frame or a list

Examples

## Not run: 
agents_families()
agents_families(id = 3)
agents_families(id = c(6, 7))
agents_families(limit = 2)
agents_families(limit = 2, parse = FALSE)

## End(Not run)

ropenscilabs/aspacer documentation built on Sept. 3, 2020, 5:30 a.m.