Skip to main content

Importing an Entity Model

irAuthor Web supports importing an entity model using a predefined JSON structure. The JSON must follow the exact required hierarchy. If the structure is incorrect, the import will fail.

If you receive the error:

Import failed due to incorrect JSON structure. Please refer to the documentation for more information and example structure.

Verify that your JSON matches the required template and rules below.

Do​

  • Use "$entity$" as the root key.
  • Include "entity" directly inside "$entity$".
  • Define each entity as a named object.
  • Define fields as key-value pairs inside each entity.
  • Ensure entity names are unique.
  • Ensure field names are unique within each entity.
  • Use valid JSON formatting.

Do Not​

  • Remove or rename "$entity$" or "entity".
  • Add additional root-level keys.
  • Use arrays instead of objects.
  • Duplicate entity names.
  • Duplicate field names within the same entity.
  • Include malformed JSON such as trailing commas or missing quotes.

Required Template​

When creating your file, start with the template and modify only entity and field names. Validate the JSON before importing.

Your JSON must follow this structure exactly:

{ 
 "$entity$": { 
   "entity": { 
     "EntityName": { 
       "Field1": "", 
       "Field2": "" 
     } 
   } 
 } 
}

You may define multiple entities under "entity":

{ 
 "$entity$": { 
   "entity": { 
     "Customer": { 
       "FirstName": "", 
       "LastName": "" 
     }, 
     "Order": { 
       "OrderNumber": "", 
       "TotalAmount": "" 
     } 
   } 
 } 
}