Model Sync Field Query | Polytomic Docs

curl -G https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/source/fields \
     -H "X-Polytomic-Version: 2024-02-08" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d "params[table]=customers" \
     -d "params[schema]=public"

{
  "data": [
    {
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      },
      "description": "Unique identifier",
      "example": null,
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "label": "ID",
      "name": "id",
      "remote_type": "string",
      "type": "string",
      "unique": true,
      "updated_at": "2024-01-15T09:30:00Z",
      "user_added": false
    },
    {
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": {
        "id": "87654321-4321-4321-4321-210987654321",
        "name": "Jane Smith",
        "type": "user"
      },
      "description": "Customer's full name",
      "example": "Alice Johnson",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "label": "Full Name",
      "name": "full_name",
      "remote_type": "varchar",
      "type": "string",
      "unique": false,
      "updated_at": "2024-01-20T11:00:00Z",
      "user_added": false
    },
    {
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": {
        "id": "87654321-4321-4321-4321-210987654321",
        "name": "Jane Smith",
        "type": "user"
      },
      "description": "Customer's email address",
      "example": "alice.johnson@example.com",
      "id": "b2c3d4e5-f678-90ab-cdef-1234567890ab",
      "label": "Email",
      "name": "email",
      "remote_type": "varchar",
      "type": "string",
      "unique": true,
      "updated_at": "2024-01-20T11:00:00Z",
      "user_added": false
    },
    {
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      },
      "description": "Date the customer was created",
      "example": "2023-12-01",
      "id": "c3d4e5f6-7890-abcd-ef12-34567890abcd",
      "label": "Created Date",
      "name": "created_date",
      "remote_type": "date",
      "type": "date",
      "unique": false,
      "updated_at": "2024-01-15T09:30:00Z",
      "user_added": false
    }
  ]
}

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.

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`](../../../../../../api-reference/model-sync/get-source).

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the connection.

Query parameters

paramsmap from strings to lists of stringsOptional

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

Response

datalist of objects or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors