All Retrieve-Only

getAppDataDir

Locate and get the application data directory

MetaApi.getAppDataDir()

Parameters

no parameters.

Returns

The application data directory.

getClassM

Get the object representing the class​

MetaApi.getClassM(className)

Parameters

className: name of the class (string)

Returns

Class metadata.

getSchemaForDataStudio

Get class schema​ for the data studio

MetaApi.getSchemaForDataStudio(className, includeAllSysAttrs)

Parameters

className:          name of the class (string)
includeAllSysAttrs:  include all system attributes (bool)

Returns

List of dictionaries containing schema details.

getDomainFileAsMap

get domain file as a hashmap.​

MetaApi.getDomainFileAsMap(fileName)

Parameters

fileName:    name of the file (string)

Returns

Content of the domain file as a dictionary.

getMetadata

Get metadata based on the ID.

MetaApi.getMetadata(id)
or
MetaApi.getMetadata(modelClassName, folder, name) 

Parameters

id (string)
modelClassName (string)
folder (string)
name (string)

Returns

Metadata details.

getClasses

Get classes based on the provided filter.

MetaApi.getClasses(filter)
or
MetaApi.getClasses(dsName, filter)
or
MetaApi.getClasses(dsName, schemaName, filter)
or
MetaApi.getClasses(appName, dsName, schemaName, filter)

Parameters

filter (string)
dsName (string)
schemaName (string)
appName (string)

Returns

List of classes.

getClassNames

Get class names based on the provided filter.

MetaApi.getClassNames(filter)
or
MetaApi.getClassNames(dsName, filter)
or
MetaApi.getClassNames(dsName, schemaName, filter)
or
MetaApi. getClassNames(appName, dsName, schemaName, filter)

Parameters

filter (string)
dsName (string)
schemaName (string)
appName (string)

Returns

List of class names.

getDataSourceNames

Get data source names based on the provided filter.

MetaApi.getDataSourceNames(filter)
or
MetaApi.getDataSourceNames(appName, filter)

Parameters

filter (string)
appName (string)

Returns

List of data source names.

getDataSources

Get data sources based on the provided filter.

MetaApi.getDataSources(filter)
or
MetaApi.getDataSources(appName, filter)

Parameters

filter (string)
appName (string)

Returns

List of data sources.