Get Connection Source

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

{
  "data": {
    "configuration": {
      "host": {
        "items": [],
        "type": "string"
      },
      "port": {
        "items": [],
        "type": "integer"
      },
      "username": {
        "items": [],
        "type": "string"
      },
      "password": {
        "items": [],
        "type": "string"
      },
      "database": {
        "items": [],
        "type": "string"
      }
    },
    "items": {
      "users": {
        "has_items": true,
        "items": [
          "id",
          "name",
          "email"
        ],
        "requires_one_of": [
          "id"
        ]
      },
      "orders": {
        "has_items": true,
        "items": [
          "order_id",
          "user_id",
          "total"
        ],
        "requires_one_of": [
          "order_id"
        ]
      }
    },
    "requires_one_of": [
      "table"
    ]
  }
}

Describes the source configuration available on a connection for use as a model sync source.

🚧 Deprecated

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

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Get Connection Source

Authentication

Path parameters

Headers

Response

Errors

Authentication

Path parameters

Headers

Response

Errors

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

1	{
2	"data": {
3	"configuration": {
4	"host": {
5	"items": [],
6	"type": "string"
7	},
8	"port": {
9	"items": [],
10	"type": "integer"
11	},
12	"username": {
13	"items": [],
14	"type": "string"
15	},
16	"password": {
17	"items": [],
18	"type": "string"
19	},
20	"database": {
21	"items": [],
22	"type": "string"
23	}
24	},
25	"items": {
26	"users": {
27	"has_items": true,
28	"items": [
29	"id",
30	"name",
31	"email"
32	],
33	"requires_one_of": [
34	"id"
35	]
36	},
37	"orders": {
38	"has_items": true,
39	"items": [
40	"order_id",
41	"user_id",
42	"total"
43	],
44	"requires_one_of": [
45	"order_id"
46	]
47	}
48	},
49	"requires_one_of": [
50	"table"
51	]
52	}
53	}