Get Sync Target | Polytomic Docs

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

{
  "data": {
    "configuration": {},
    "items": {
      "public_schema": {
        "has_items": true,
        "items": [
          "users",
          "orders",
          "products"
        ],
        "requires_one_of": [
          "table"
        ]
      },
      "analytics_schema": {
        "has_items": true,
        "items": [
          "sales_summary",
          "customer_segments"
        ],
        "requires_one_of": [
          "view"
        ]
      }
    },
    "requires_one_of": [
      "table"
    ]
  }
}

Returns target metadata for a connection.

🚧 Deprecated

Use GET /api/connections/{id}/modelsync/targetobjects instead.

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

typestringOptional

Target object type to query (e.g. schema name). When supplied, the response is narrowed to objects matching this type.

searchstringOptional

Substring filter applied to target object names. Combine with type to browse large schemas.

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