Class UpdateRecordAction

Generic action for updating existing entity records in the database. This action provides a flexible way to update records for any entity type by accepting the entity name, primary key, and field values as parameters.

Example

// Update a customer record
await runAction({
  ActionName: 'Update Record',
  Params: [
    {
      Name: 'EntityName',
      Value: 'Customers'
    },
    {
      Name: 'PrimaryKey',
      Value: { ID: '123e4567-e89b-12d3-a456-426614174000' }
    },
    {
      Name: 'Fields',
      Value: {
        Email: 'newemail@example.com',
        Status: 'Inactive',
        UpdatedAt: new Date()
      }
    }
  ]
});

Hierarchy

BaseRecordMutationAction
- UpdateRecordAction

Index

Constructors

constructor

Methods

InternalRunAction Run analyzeEntityError getEntityNameParam getEntityObject getFieldsParam getPrimaryKeyParam handleError loadRecord setFieldValues

Constructors

constructor

new UpdateRecordAction(): UpdateRecordAction
Returns UpdateRecordAction
Inherited from BaseRecordMutationAction.constructor

Methods

InternalRunAction

InternalRunAction(params): Promise<ActionResultSimple>
Updates an existing record for the specified entity type.
Parameters
- params: RunActionParams<any>
  The action parameters containing:
  - EntityName (required): The name of the entity to update
  - PrimaryKey (required): Object containing primary key field(s) and value(s)
  - Fields (required): Object containing field names and values to update
Returns Promise<ActionResultSimple>
ActionResultSimple with:
- Success: true if record was updated successfully
- ResultCode: SUCCESS, FAILED, ENTITY_NOT_FOUND, RECORD_NOT_FOUND, VALIDATION_ERROR, PERMISSION_DENIED, NO_CHANGES, CONCURRENT_UPDATE
- Message: Details about the operation
- Params: Output parameter 'UpdatedFields' contains the fields that were actually changed
Overrides BaseRecordMutationAction.InternalRunAction
- Defined in CoreActions/src/custom/crud/update-record.action.ts:55

Run

Run(params): Promise<ActionResultSimple>
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
Inherited from BaseRecordMutationAction.Run
- Defined in Engine/dist/generic/BaseAction.d.ts:37

`Protected` analyzeEntityError

analyzeEntityError(entity, operation, entityName): ActionResultSimple
Analyze error from entity save/delete operation and return appropriate result
Parameters
- entity: BaseEntity<unknown>
- operation: "delete" | "create" | "update"
- entityName: string
Returns ActionResultSimple
Inherited from BaseRecordMutationAction.analyzeEntityError
- Defined in CoreActions/src/custom/crud/base-record-mutation.action.ts:175

`Protected` getEntityNameParam

getEntityNameParam(params): {
error?: ActionResultSimple;
value?: string;
}
Extract and validate the EntityName parameter
Parameters
- params: RunActionParams<any>
Returns {
error?: ActionResultSimple;
value?: string;
}
- Optional error?: ActionResultSimple
- Optional value?: string
Inherited from BaseRecordMutationAction.getEntityNameParam
- Defined in CoreActions/src/custom/crud/base-record-mutation.action.ts:16

`Protected` getEntityObject

getEntityObject(entityName, contextUser): Promise<{
    entity?: BaseEntity<unknown>;
    entityInfo?: any;
    error?: ActionResultSimple;
}>
Get entity metadata and create entity object
Parameters
- entityName: string
- contextUser: any
Returns Promise<{
    entity?: BaseEntity<unknown>;
    entityInfo?: any;
    error?: ActionResultSimple;
}>
Inherited from BaseRecordMutationAction.getEntityObject
- Defined in CoreActions/src/custom/crud/base-record-mutation.action.ts:73

`Protected` getFieldsParam

getFieldsParam(params): {
error?: ActionResultSimple;
value?: Record<string, any>;
}
Extract and validate the Fields parameter
Parameters
- params: RunActionParams<any>
Returns {
error?: ActionResultSimple;
value?: Record<string, any>;
}
- Optional error?: ActionResultSimple
- Optional value?: Record<string, any>
Inherited from BaseRecordMutationAction.getFieldsParam
- Defined in CoreActions/src/custom/crud/base-record-mutation.action.ts:54

`Protected` getPrimaryKeyParam

getPrimaryKeyParam(params): {
error?: ActionResultSimple;
value?: Record<string, any>;
}
Extract and validate the PrimaryKey parameter
Parameters
- params: RunActionParams<any>
Returns {
error?: ActionResultSimple;
value?: Record<string, any>;
}
- Optional error?: ActionResultSimple
- Optional value?: Record<string, any>
Inherited from BaseRecordMutationAction.getPrimaryKeyParam
- Defined in CoreActions/src/custom/crud/base-record-mutation.action.ts:35

`Protected` handleError

handleError(e, operation): ActionResultSimple
Handle generic errors with consistent formatting
Parameters
- e: any
- operation: string
Returns ActionResultSimple
Inherited from BaseRecordMutationAction.handleError
- Defined in CoreActions/src/custom/crud/base-record-mutation.action.ts:222

`Protected` loadRecord

loadRecord(entity, entityInfo, primaryKey, entityName): Promise<{
error?: ActionResultSimple;
success: boolean;
}>
Load an existing record using primary key
Parameters
- entity: BaseEntity<unknown>
- entityInfo: any
- primaryKey: Record<string, any>
- entityName: string
Returns Promise<{
error?: ActionResultSimple;
success: boolean;
}>
Inherited from BaseRecordMutationAction.loadRecord
- Defined in CoreActions/src/custom/crud/base-record-mutation.action.ts:108

`Protected` setFieldValues

setFieldValues(entity, fields, entityName): void
Set field values on an entity
Parameters
- entity: BaseEntity<unknown>
- fields: Record<string, any>
- entityName: string
Returns void
Inherited from BaseRecordMutationAction.setFieldValues
- Defined in CoreActions/src/custom/crud/base-record-mutation.action.ts:162

Class UpdateRecordAction

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns UpdateRecordAction

Methods

InternalRunAction

Parameters

Returns Promise<ActionResultSimple>

Run

Parameters

Returns Promise<ActionResultSimple>

Protected analyzeEntityError

Parameters

Returns ActionResultSimple

Protected getEntityNameParam

Parameters

Returns { error?: ActionResultSimple; value?: string; }

Optional error?: ActionResultSimple

Optional value?: string

Protected getEntityObject

Parameters

Returns Promise<{ entity?: BaseEntity<unknown>; entityInfo?: any; error?: ActionResultSimple; }>

Protected getFieldsParam

Parameters

Returns { error?: ActionResultSimple; value?: Record<string, any>; }

Optional error?: ActionResultSimple

Optional value?: Record<string, any>

Protected getPrimaryKeyParam

Parameters

Returns { error?: ActionResultSimple; value?: Record<string, any>; }

Optional error?: ActionResultSimple

Optional value?: Record<string, any>

Protected handleError

Parameters

Returns ActionResultSimple

Protected loadRecord

Parameters

Returns Promise<{ error?: ActionResultSimple; success: boolean; }>

Protected setFieldValues

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Protected` analyzeEntityError

`Protected` getEntityNameParam

Returns {
error?: ActionResultSimple;
value?: string;
}

`Optional` error?: ActionResultSimple

`Optional` value?: string

`Protected` getEntityObject

Returns Promise<{
entity?: BaseEntity<unknown>;
entityInfo?: any;
error?: ActionResultSimple;
}>

`Protected` getFieldsParam

Returns {
error?: ActionResultSimple;
value?: Record<string, any>;
}

`Optional` error?: ActionResultSimple

`Optional` value?: Record<string, any>

`Protected` getPrimaryKeyParam

Returns {
error?: ActionResultSimple;
value?: Record<string, any>;
}

`Optional` error?: ActionResultSimple

`Optional` value?: Record<string, any>

`Protected` handleError

`Protected` loadRecord

Returns Promise<{
error?: ActionResultSimple;
success: boolean;
}>

`Protected` setFieldValues