Get Sync Source | Polytomic Docs

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

Use this endpoint before creating a model to understand what configuration is available. Once you have a configuration, resolve the fields available for sync mapping with GET /api/connections/{id}/modelsync/source/fields.

Describes the source configuration available on a connection for use as a model sync source. Use this endpoint before creating a model to understand what configuration is available. Once you have a configuration, resolve the fields available for sync mapping with [`GET /api/connections/{id}/modelsync/source/fields`](../../../../../api-reference/model-sync/get-source-fields).

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the connection.

Query parameters

paramsmap from strings to lists of stringsOptional

Query parameters used to incrementally refine a dependent source configuration. Keys correspond to configuration fields returned by previous calls to this endpoint.

Response

dataobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/source \
2	-H "X-Polytomic-Version: X-Polytomic-Version" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json"

1	{
2	"data": {
3	"configuration": {},
4	"items": {},
5	"requires_one_of": [
6	"database"
7	]
8	}
9	}