Download a set of Office actions based on a query to the Office Action Text Retrieval API.

download_office_actions(criteria = "*:*", outFile = NULL, start = 0,
  limit = FALSE, overwrite = FALSE,
  endpoint = "https://developer.uspto.gov/ds-api/oa_actions/v1/records",
  compress = TRUE, cores = detectCores() - 2, verbose = TRUE)

Arguments

criteria

Search criteria, in the form of "field:value" (e.g., "examinerEmployeeNumber:80488"). See available fields.

outFile

Path to the resulting JSON file; defaults to the hash of the query in the current working directory.

start

Initial record; useful if making requests in chunks.

limit

Maximum number of office actions to return; under 1,000, or in steps of 1,000; defaults to all found.

overwrite

Logical; if TRUE, will overwrite an existing file with the same outFile.

endpoint

API endpoint.

compress

Logical; if FALSE, will not write a compressed file.

cores

Number of CPU cores to split calls across if necessary.

verbose

Logical; if FALSE, will not print status messages.

Value

A list of office actions.

Examples

if (FALSE) {
# retrieve the office actions associated with a particular application
office_actions <- download_office_actions("patentApplicationNumber:13877637")
}