Get Connection Target | Polytomic Docs

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

{
  "data": {
    "configuration": {},
    "items": {
      "public.users": {
        "has_items": true,
        "items": [
          {
            "name": "id",
            "type": "integer",
            "nullable": false,
            "primary_key": true
          },
          {
            "name": "email",
            "type": "varchar(255)",
            "nullable": false,
            "primary_key": false
          },
          {
            "name": "created_at",
            "type": "timestamp",
            "nullable": false,
            "primary_key": false
          }
        ],
        "requires_one_of": [
          "column"
        ]
      },
      "public.orders": {
        "has_items": true,
        "items": [
          {
            "name": "order_id",
            "type": "uuid",
            "nullable": false,
            "primary_key": true
          },
          {
            "name": "user_id",
            "type": "integer",
            "nullable": false,
            "primary_key": false
          },
          {
            "name": "order_date",
            "type": "date",
            "nullable": false,
            "primary_key": false
          }
        ],
        "requires_one_of": [
          "column"
        ]
      }
    },
    "requires_one_of": [
      "table"
    ]
  }
}

Returns target metadata for a connection.

🚧 Deprecated

Use GET /api/connections/{id}/modelsync/targetobjects 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"

Query parameters

typestringOptional

searchstringOptional

Response

dataobject

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