getEntityMetadata: getEntityMetadata - Get entity metadata.

Description Usage Arguments Details Author(s) Examples

View source: R/getEntityMetadata.R

Description

getEntityMetadata Get entity metadata by entityType. Returns a list with three data frames named attributes, associations, and template. Template can be used as the body for createEntity functions.

Usage

1
getEntityMetadata(coreApi, entityType, ...)

Arguments

coreApi

coreApi object with valid jsessionid

entityType

entity type to get metadata for

...

additional arguments passed to apiGET #' @return List of length 3, containing attributes, associations, and template objects:

  • attributes is a list of attribute properties.

  • response is a list of association properties.

  • template is a list convertable to JSON for object creation.

Details

getEntityMetadata Get entity metadata.

Author(s)

Craig Parman info@ngsanalytics.com

Scott Russell scott.russell@thermofisher.com

Examples

1
2
3
4
5
6
7
## Not run: 
api <- coreAPI("PATH TO JSON FILE")
login <- authBasic(api)
item <- getEntityMetadata(login$coreApi, "entityType")
logOut(login$coreApi)

## End(Not run)

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