POpolytomic
Model Sync

Start Sync

Changed on

Starts a new execution of a model sync.

🚧 Force full resync

Use caution when setting the resync parameter to true. This will force a full resync of the data from the source system. This can be a time-consuming operation and may impact the performance of the source system. It is recommended to only use this option when necessary.

post/api/syncs/{id}/executions

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

Model sync ID

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Request body

identitiesstring[] nullable

Values of the sync's identity source field naming the records to sync. A sync with more than one identity mapping requires 'source_identities' instead. Cannot be combined with 'resync'.

resyncboolean

Whether the execution ignores change tracking and syncs every record; on a sync that skips the initial backfill, it instead restarts change tracking from the current position without syncing existing records

testboolean

Whether the execution is a test that syncs at most 5 records. Cannot be combined with 'resync'.

Example request

{
  "source_identities": [
    [
      {
        "source": {
          "field": "id",
          "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
        }
      }
    ]
  ]
}

Response

OK

Example response

{
  "data": {
    "created_at": "2024-01-01T00:00:00Z",
    "id": "7f3e9c2a-4b8d-4f1e-a9c3-6d5e2f8b1a7c"
  }
}

Changes

  • 61c2b96f65baRevision changes
    • breaking

      added to the /// request property allOf list

    • breaking

      the /// request property type changed from object to no type

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status

  • 01e314882a97Revision changes
    • info

      api operation id api/v2.StartSync removed and replaced with api/v5.StartSync

    • info

      added the new optional request property