Connection Field Query | Polytomic Docs

curl -X POST https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/source/fields \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "query": {
    "query": "select * from public.users"
  }
}'

{
  "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 user",
      "example": 101,
      "id": "a3f1c2d4-5678-4e9a-b123-456789abcdef",
      "label": "User ID",
      "name": "user_id",
      "remote_type": "integer",
      "type": "integer",
      "unique": true,
      "updated_at": "2024-01-15T09:30:00Z",
      "user_added": false
    }
  ]
}

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

🚧 Deprecated

Use POST /api/connections/{id}/modelsync/source/fields instead. Available in API version 2024-02-08 and later.

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

querymap from strings to any or nullRequired

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

Request

Response

Errors