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

    Methods

    InternalRunAction Run

    Constructors

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods