The Open API specification for Synapse is now available for download!

Download Open API Spec

POST /grid/synchronize/async/start

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

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

Resource Information
Authentication Required
Required OAuth Scopes view , modify
HTTP Method POST
Request Object SynchronizeGridRequest
(application/json)
Response Object AsyncJobId
(application/json)