apiPUT: apiPUT - Do a PUT to the PFS API.

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

Description

apiPUT - Do a PUT to the PFS API.

Usage

apiPUT(coreApi, resource = NULL, query = NULL, body = NULL, encode,
  headers = NULL, special = NULL, useVerbose = FALSE, unbox = TRUE,
  valueFlag = FALSE, fullReturn = TRUE)

Arguments

coreApi	coreApi object with valid jsessionid
resource	entity type for PUT
query	query string
body	body for request
encode	encoding to use for request option are "multipart", "form", "json", "raw"
headers	headers to be added to httr::PUT.
special	passed to buildUrl for special sdk endpoints
useVerbose	use verbose communication for debugging
unbox	use autounbox when doing list-to-JSON conversion
valueFlag	Tells the PUT if there needs to be a /$value added to the end.
fullReturn	Return the entire response object, or just the response content (default TRUE)

Details

apiPUT Do a PUT to the PFS API.

Value

List of length 2, containing content and response objects:

• content is the HTTP response content.

• response is the entire HTTP response. NULL if fullReturn is FALSE.

Author(s)

Craig Parman [e-mail]

Adam Wheeler [e-mail]

Francisco Marin [e-mail]

Scott Russell [e-mail]

Examples

## Not run: 
api <- coreAPI("PATH TO JSON FILE")
login <- authBasic(api)
response <- apiPUT(login$coreApi,
  "SAMPLE",
  body,
  "json",
  special = NULL,
  useVerbose = FALSE,
  unbox = TRUE
)
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.