Generic action for creating new entity records in the database. This action provides a flexible way to create records for any entity type by accepting the entity name and field values as parameters.

Example

// Create a new customer record
const result = await runAction({
ActionName: 'Create Record',
Params: [
{
Name: 'EntityName',
Value: 'Customers'
},
{
Name: 'Fields',
Value: {
Name: 'John Doe',
Email: 'john@example.com',
Status: 'Active'
}
}
]
});

// The PrimaryKey output parameter contains an object with the key field(s)
// For example: { CustomerID: '12345' }
const primaryKey = result.Params.find(p => p.Name === 'PrimaryKey')?.Value;

Hierarchy (view full)

Constructors

Methods

  • Creates a new record for the specified entity type.

    Parameters

    • params: RunActionParams<any>

      The action parameters containing:

      • EntityName (required): The name of the entity to create
      • Fields (required): Object containing field names and values to set

    Returns Promise<ActionResultSimple>

    ActionResultSimple with:

    • Success: true if record was created successfully
    • ResultCode: SUCCESS, FAILED, ENTITY_NOT_FOUND, VALIDATION_ERROR, PERMISSION_DENIED
    • Message: Details about the operation
    • Params: Output parameter 'PrimaryKey' contains an object with the primary key field(s) and value(s)
  • 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