Mappings

Retrieve the mappings document

The declarative mappings document, referencing tables and fields by remote id. The ETag header carries the revision — send it back as If-Match on the PUT for a compare-and-set update. A pair that has a sync filter or a non-default advanced setting also reports them read-only, under filter and advanced_settings.

get/v1/sync/syncs/{sync_id}/mappings

Request

  • Base URL: https://api.whalesync.com
  • URL: https://api.whalesync.com/v1/sync/syncs/{sync_id}/mappings
  • Auth: HTTP bearer

Path parameters

sync_idstring required
Example:sync_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41

Response

The current document.

Example response

{
  "tables": [
    {
      "left": {
        "view": "viwActive"
      },
      "right": {
        "view": "viwActive"
      },
      "filter": {
        "conditions": [
          {
            "left_field": "fldStage",
            "right_field": "stage"
          }
        ],
        "summary": "Only records where Stage is \"Won\" and Amount is at least \"100\" are synced.",
        "docs_url": "https://docs.whalesync.com/features/filters"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.