Member Junction
    Preparing search index...

    Class GetEntityDetailsAction

    Action that returns field details and sample data for a specific entity. Perfect for understanding entity structure before writing queries.

    Returns:

    • Field names, types, descriptions
    • Sample data (top 3 rows by default, capped at 10; individual field values truncated to a few hundred characters to keep agent context bounded)
    • Total row count
    • Primary key information
    • Related entity references

    This action uses RunView (cached metadata + query) - very fast and efficient.

    // Get details for Customers entity
    await runAction({
      ActionName: 'Get Entity Details',
      Params: [{
        Name: 'EntityName',
        Value: 'Customers'
      }]
    });

    // Get more sample rows
    await runAction({
      ActionName: 'Get Entity Details',
      Params: [{
        Name: 'EntityName',
        Value: 'Orders'
      }, {
        Name: 'SampleRowCount',
        Value: 10
      }]
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    AuthorizesCaller

    Methods

    InternalRunAction Run

    Constructors

    Properties

    AuthorizesCaller: boolean

    True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

    The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods