Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Model Sync

Model Sync Field Query

Returns the source fields available on a connection for a given source configuration.

Pass the model's source configuration as query parameters to resolve the fields that the connection will expose for that specific configuration. The returned fields are what can be referenced in sync field mappings.

📘 Results depend on the source configuration you supply. A different table or query in the configuration may return a completely different field list.

The available source configuration parameters are described by GET /api/connections/{id}/modelsync/source.

get/api/connections/{id}/modelsync/source/fields

Path parameters

idstring uuid required

Unique identifier of the connection.

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

Unique identifier of the connection.

Query parameters

paramsobject

Source configuration, matching the params used with GET /api/connections/{id}/modelsync/source, that selects the specific source to return fields for.

Source configuration, matching the params used with GET /api/connections/{id}/modelsync/source, that selects the specific source to return fields for.

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": [
    {
      "created_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      },
      "description": "Unique identifier",
      "example": 123,
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "label": "ID",
      "name": "id",
      "remote_type": "string",
      "type": "string",
      "unique": true
    }
  ]
}