v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB

Model Sync

Get Sync

Returns a single model sync by ID.

To check whether a sync is currently running or has recently completed, use GET /api/syncs/{id}/status. For the full history of executions, use GET /api/syncs/{id}/executions.

get/api/syncs/{id}

Path parameters

idstring uuid required

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

Headers

X-Polytomic-Versionstring

Response

Example response

{
  "data": {
    "active": true,
    "created_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    },
    "fields": [
      {
        "override_value": "fixed_value",
        "source": {
          "field": "id",
          "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
        },
        "sync_mode": "create",
        "target": "name"
      }
    ],
    "filters": [
      {
        "field": {
          "field": "id",
          "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
        },
        "field_id": "field1",
        "label": "A",
        "value": "value"
      }
    ],
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "identity": {
      "remote_field_type_id": "string",
      "source": {
        "field": "id",
        "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
      },
      "target": "name"
    },
    "name": "Users Sync",
    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "override_fields": [
      {
        "override_value": "fixed_value",
        "sync_mode": "create",
        "target": "name"
      }
    ],
    "overrides": [
      {
        "field": {
          "field": "id",
          "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
        },
        "field_id": "field1",
        "override": "new_value",
        "value": "value"
      }
    ],
    "policies": [
      "248df4b7-aa70-47b8-a036-33ac447e668d"
    ],
    "schedule": {
      "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "day_of_month": "1",
      "day_of_week": "monday",
      "hour": "12",
      "minute": "30",
      "month": "1",
      "run_after": {
        "bulk_sync_ids": [
          "248df4b7-aa70-47b8-a036-33ac447e668d"
        ],
        "sync_ids": [
          "248df4b7-aa70-47b8-a036-33ac447e668d"
        ]
      }
    },
    "target": {
      "configuration": {
        "key": "value"
      },
      "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "create": {
        "name": "value"
      },
      "object": "Users",
      "search_values": {
        "name": "value"
      }
    },
    "updated_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    }
  }
}