apiPOST: apiPOST - Do a POST to the PFS API.

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

Description

apiPOST - Do a POST to the PFS API.

Usage

apiPOST(coreApi, resource = NULL, body = NULL, encode,
  headers = NULL, special = NULL, useVerbose = FALSE,
  fullReturn = TRUE)

Arguments

coreApi	coreApi object with valid jsessionid
resource	entity type for POST
body	body for request
encode	encode type must be "multipart", "form", "json", "raw"
headers	headers to be added to httr::POST.
special	passed to buildUrl for special sdk endpoints
useVerbose	Use verbose communication for debugging
fullReturn	Return the entire response object, or just the response content (default TRUE)

Details

apiPOST Do a POST 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]

Francisco Marin [e-mail]

Scott Russell [e-mail]

Examples

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