ModelSchema

// to fetch a ModelSchema from a app
var entity = insight
     .getView()
     .getApp()
     .getModelSchema();

// to fetch a ModelSchema from a scenario instance
var entity = scenario
     .getModelSchema();

Method summary

Methods

method

findArraysIndexedBy ( entityNames ) → {Array.<object>}

Finds all array entities that are indexed by the given list of entity names.

The match is exact and the order of the index names is significant.

Parameters:

params

Name	Type	Description
entityNames	type Array.<string>	the list of entity names expected in the index set

details

Returns:

returns table

Type	Description
type Array.<object>	The array of entities that are indexed by the required index sets, empty if none are found

Example

examples

var entityNameList = modelSchema.findArraysIndexedBy(['INDEX_SET1', 'INDEX_SET2']);

Back to Top

method

getAllEntities ( ) → {Object.<string, ModelEntity>}

All the entities in this schema.

details

Returns:

returns table

Type	Description
type Object.<string, ModelEntity>	an array of all the entities in this schema

Example

examples

var allEntities = modelSchema.getAllEntities();

Back to Top

method

getAppId ( ) → {string}

The app id of this model schema.

details

Returns:

returns table

Type	Description
type string	The app id of this model schema

Example

examples

modelSchema.getAppId();

Back to Top

method

getEntity ( entityName ) → {ModelEntity}

Gets an entity by name.

Parameters:

params

Name	Type	Description
entityName	type string	the name of the entity

details

Returns:

returns table

Type	Description
type ModelEntity	the entity or undefined if no entity exists with that name

Example

examples

var entity = modelSchema.getEntity('ENTITY_NAME');

Back to Top

method

getProjectId ( )

Use ModelSchema#getAppId instead.

details

• Deprecated since Js Api 4.5

Back to Top