Class RunSyncAction

MJ Action that triggers a sync for a CompanyIntegration.

Parameters (Input):

CompanyIntegrationID (required): ID of the CompanyIntegration to sync
TriggerType (optional): 'Scheduled' | 'Manual' | 'Webhook' (default: 'Manual')
FullSync (optional): 'true' to force a full sync ignoring watermarks
EntityMapIDs (optional): comma-separated list of EntityMapIDs to restrict the sync

Parameters (Output):

RecordsProcessed: total records processed
RecordsCreated: records created
RecordsUpdated: records updated
RecordsDeleted: records deleted
RecordsErrored: records that encountered errors
RecordsSkipped: records that were skipped
ErrorSummary: JSON string of error details (first 10 errors)

Hierarchy (View Summary)

BaseAction
- RunSyncAction

Index

Constructors

Methods

InternalRunAction Run

Constructors

constructor

new RunSyncAction(): RunSyncAction
Returns RunSyncAction
Inherited from BaseAction.constructor

Methods

`Protected`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Internal method that must be implemented by derived action classes. This is where the actual action logic should be implemented.
Parameters
- params: RunActionParams
  The action execution parameters including typed context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Overrides BaseAction.InternalRunAction
- Defined in Integration/actions/src/RunSyncAction.ts:28

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseAction.Run
- Defined in Actions/Engine/dist/generic/BaseAction.d.ts:37