getEntityByName: getEntityByName - Get an entity by name from the Core LIMS...

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

Description

getEntityByName Get an entity by name from the Core LIMS using the ODATA API.

Usage

getEntityByName(coreApi, entityType, name, fullMetadata = FALSE, ...)

Arguments

coreApi	coreApi object with valid jsessionid
entityType	entity type to get
name	name of entity to get
fullMetadata	- get full metadata, default is FALSE
...	additional arguments passed to apiGET

Details

getEntityByName get an entity by name from the Core LIMS using the ODATA API.

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]

Adam Wheeler [e-mail]

Natasha Mora [e-mail]

Examples

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

## End(Not run)

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