createEntity: createEntity - Create a new instance of a entity. Used for...

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

Description

createEntity Creates a new entity instance. Required inputs are url, jsessionId and entityType.

Usage

createEntity(coreApi, entityType, body, locationId = NULL,
  projectIds = NULL, barcode = NULL, fullMetadata = FALSE, ...)

Arguments

coreApi	coreApi object with valid jsessionid
entityType	entity type to get as character string
body	values for attributes and associations as a list of key-values pairs
locationId	location ID for initial location as character string
projectIds	project comma separated list of project IDs as character string
barcode	User provided barcode as a character string
fullMetadata	get full metadata, default is FALSE
...	additional arguments passed to apiPOST

Details

createEntity Create a new instance of a entity. Used for standard object or "Plan Old Core Objects" (POCOs)

Value

List of length 2, containing entity and response objects:

• entity is the HTTP response content.

• response is the entire HTTP response.

Author(s)

Craig Parman [e-mail]

Natasha Mora [e-mail]

Scott Russell [e-mail]

Examples

## Not run: 
api <- coreAPI("PATH TO JSON FILE")
login <- authBasic(api)
item <- createEntity(login$coreApi, "Entity_Type")
logOut(login$coreApi)

## End(Not run)

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