attachFile: attachFile - Attaches a file to an entity or file attribute.

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

Description

attachFile Attaches a file to entity identified by barcode. Note: This function uses the JSON API to post a file to an entity and Odata to post to an attribute.

Usage

attachFile(coreApi, entityType, barcode, filePath,
  targetAttributeName = "", ...)

Arguments

coreApi	coreApi object with valid jsessionid
entityType	PFS entity type
barcode	User provided barcode as a character string
filePath	path to the file to attach
targetAttributeName	- if included the name if the attribute to attach the file to. Must be in all caps.
...	additional arguments passed to apiPUT

Details

attachFile Attaches a file to an entity or file attribute.

Value

List of length 2, containing content and response objects:

• content is the HTTP response content. If targetAttributeName is not empty, content will return as NULL.

• response is the entire HTTP response. If fullReturn is FALSE will return as NULL.

Author(s)

Craig Parman [e-mail]

Adam Wheeler [e-mail]

Scott Russell [e-mail]

Examples

## Not run: 
api <- coreAPI("PATH TO JSON FILE")
login <- authBasic(api)
modifiedItem <- attachFile(login$coreApi,
  entitytype,
  barcode,
  filePath,
  targetAttributeName = "",
  useVerbose = FALSE
)
logOut(login$coreApi)

## End(Not run)

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