Get Entity-Level Metadata

When you need entity-level metadata, you can get it based on Entity ID, Entity Name, or GE Object.

1. Get Entity Metadata when you already have a GE Object. This is a synchronous function that returns the entity metadata.

   // Assumes you already have a variable called 'ge' holding a GE Object.
   var entityMd = ge.entityMetaData();

2. Get Entity Metadata knowing the Entity Name using Aptify.framework.metaData.entities.loadEntity(). This is an asynchronous function that passes the entity metadata into its callback.

   var entityName = "Persons";
    
   Aptify.framework.metaData.entities.loadEntity(entityName, function (entityMd) {
   	// entityMd contains the entity metadata
   });

3. Get Entity Metadata knowing the Entity ID using Aptify.framework.metaData.entities.loadEntityById(). This is an asynchronous function that passes the entity metadata into its callback.

   Because Entity IDs are not reliable cross-database, we don't recommend this as a primary approach. However, when you are in a situation in which some other part of the system has provided the Entity ID, this method is handy.

   var entityId = 1006;
    
   Aptify.framework.metaData.entities.loadEntityById(entityId, function (entityMd) {
   	// entityMd contains the entity metadata
   });

Related articles

• Page:
  When to Manually Generate Metadata
• Page:
  Defining the Wizard Scope Tab
• Page:
  Using Process Flows to Add Functionality and Conditional Paging Logic
• Page:
  Inherit From Stock JavaScript
• Page:
  About the Visual Designer Time Control