Generic action for retrieving entity records from the database. This action provides a flexible way to fetch records for any entity type by accepting the entity name and primary key values as parameters.

Example

// Get a single record by ID
await runAction({
ActionName: 'Get Record',
Params: [
{
Name: 'EntityName',
Value: 'Customers'
},
{
Name: 'PrimaryKey',
Value: { ID: '123e4567-e89b-12d3-a456-426614174000' }
}
]
});

// Get a record with composite primary key
await runAction({
ActionName: 'Get Record',
Params: [
{
Name: 'EntityName',
Value: 'UserRoles'
},
{
Name: 'PrimaryKey',
Value: {
UserID: '123e4567-e89b-12d3-a456-426614174000',
RoleID: '987f6543-e21b-12d3-a456-426614174000'
}
}
]
});

Hierarchy

  • BaseRecordMutationAction
    • GetRecordAction

Constructors

Methods

  • Retrieves a record for the specified entity type using its primary key.

    Parameters

    • params: RunActionParams<any>

      The action parameters containing:

      • EntityName (required): The name of the entity to retrieve
      • PrimaryKey (required): Object containing primary key field(s) and value(s)

    Returns Promise<ActionResultSimple>

    ActionResultSimple with:

    • Success: true if record was retrieved successfully
    • ResultCode: SUCCESS, FAILED, ENTITY_NOT_FOUND, RECORD_NOT_FOUND, VALIDATION_ERROR, PERMISSION_DENIED
    • Message: Details about the operation
    • Params: Output parameter 'Record' contains the retrieved entity data
  • Executes the action with the provided parameters.

    Parameters

    • params: RunActionParams<any>

      The action execution parameters including context

    Returns Promise<ActionResultSimple>

    Promise resolving to the action result