apiGET: apiGET - Do a GET from the PFS API.

In AmundsenJunior/pfsrsdk: Functions for interacting with Platform for Science APIs

Description

apiGET - Do a GET from the PFS API.

Usage

apiGET(coreApi, resource, query, headers = NULL, special = NULL,
  useVerbose = FALSE, useRaw = FALSE, fullReturn = TRUE)

Arguments

coreApi	coreApi object with valid jsessionid
resource	entity type to get
query	query string
headers	headers to be added to httr::GET.
special	passed to buildUrl for special sdk endpoints
useVerbose	Use verbose communication for debugging (default FALSE)
useRaw	Return raw response content (default FALSE)
fullReturn	Return the entire response object, or just the response content (default TRUE)

Details

apiGET Do a GET from the PFS API.

Value

List of length 2, containing content and response objects:

• content is the HTTP response content (concatenated if a chunked response).

• response is the entire HTTP response. If chuncked, response object contains the full HTTP response of the last HTTP GET call. NULL if fullReturn is FALSE.

Author(s)

Craig Parman [e-mail]

Francisco Marin [e-mail]

Natasha Mora [e-mail]

Scott Russell [e-mail]

Examples

## Not run: 
api <- coreAPI("PATH TO JSON FILE")
login <- authBasic(api)
response <- apiGET(login$coreApi, "json", resource, query)
content <- response$content
error <- response$error$message
logOut(login$coreApi)

## End(Not run)

AmundsenJunior/pfsrsdk documentation built on July 18, 2019, 8:10 p.m.