Synapse REST API

Asynchronously start the synchronization of a grid session with its data source. Synchronization is a two-phase process that ensures consistency between the user's local changes and external changes made to the source:

Phase 1: Schema Synchronization

• Synchronizes column definitions between the grid copy and source
• Resolves schema conflicts

Phase 2: Row Synchronization

• Synchronizes row data using the final schema from Phase 1
• Merges cell-level changes when rows conflict
• Pushes user changes from copy to source
• Pulls external changes from source to copy

Benefactor ID Update ( mode)

After row synchronization completes, the session's stored benefactor IDs are refreshed to reflect the current state of the source as seen by the calling user (the action user). The benefactor set is recomputed using the same rules as session creation:

• For view sources: the distinct set of benefactor IDs from the rows the action user has EDIT access to at the time of the sync.
• For table or RecordSet sources: the single benefactor of the source entity.

This means that if the underlying data or permissions change between session creation and sync, the set of users who can join the session may expand or contract accordingly. In particular, if a new entity with a separate benefactor appears in the view scope, users who lack EDIT on that benefactor will lose access to the session after the next sync.

Use the returned job id and GET /grid/synchronize/async/get to get the results of the job.

Resource URL

https://repo-prod.prod.sagebase.org/repo/v1/grid/synchronize/async/start