getEntityMetadata: getEntitMetadata - Get entity metadata.

In ceparman/Core5.3: Core API fucntions

Description

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

Usage

getEntityMetadata(coreApi, entityType, useVerbose = FALSE)

Arguments

coreApi	coreApi object with valid jsessionid
entityType	entity type to get metadata for
useVerbose	TRUE or FALSE to indicate if verbose options should be used in http POST

Details

getEntityMetadata Get entity metadata.

Value

returns a list containing $attributes for attribute properties, and $association for association properties; $template contains a list that can be converted to JSON for object creation.

Author(s)

Craig Parman ngsAnalytics, ngsanalytics.com

Examples

## Not run: 
api<-CoreAPIV2::CoreAPI("PATH TO JSON FILE")
login<- CoreAPIV2::authBasic(api)
item<-CoreAPIV2::getEntityMetadata(login$coreApi,"entityType","barcode")
CoreAPIV2::logOut(login$coreApi)

## End(Not run)

ceparman/Core5.3 documentation built on May 7, 2019, 8:16 a.m.