Model Sync Field Query | Polytomic Docs

curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/source/fields \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>"

{
  "data": [
    {
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      },
      "description": "Unique identifier for the customer record",
      "example": "c12345",
      "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
      "label": "Customer ID",
      "name": "customer_id",
      "remote_type": "varchar(36)",
      "type": "string",
      "unique": true,
      "updated_at": "2024-04-10T11:45:00Z",
      "user_added": false
    },
    {
      "created_at": "2024-01-15T09:35:00Z",
      "created_by": {
        "id": "87654321-4321-4321-4321-210987654321",
        "name": "Jane Smith",
        "type": "user"
      },
      "description": "Customer's email address",
      "example": "jane.smith@example.com",
      "id": "b2c3d4e5-f678-9012-ab34-cd56ef789012",
      "label": "Email",
      "name": "email",
      "remote_type": "varchar(255)",
      "type": "string",
      "unique": true,
      "updated_at": "2024-04-10T11:50:00Z",
      "user_added": false
    },
    {
      "created_at": "2024-01-15T09:40:00Z",
      "created_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      },
      "description": "Date when the customer record was created",
      "example": "2023-12-01",
      "id": "c3d4e5f6-7890-1234-ab56-cd78ef901234",
      "label": "Created Date",
      "name": "created_date",
      "remote_type": "date",
      "type": "string",
      "unique": false,
      "updated_at": "2024-04-10T11:55:00Z",
      "user_added": false
    }
  ]
}

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

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