Skip to navigation

List Sync Targets

Lists the target objects available on a connection for use as a model sync destination.

If the connection supports creating new destinations, the target_creation object will contain information on what properties are required to create the target.

Target creation properties are all string values; the enum flag indicates if the property has a fixed set of valid values. When enum is true, the Target Creation Property Values endpoint can be used to retrieve the valid values. Alternatively, pass include_target_creation_values=true to inline the values array for each enum property directly in this response.

Sync modes

The sync mode determines which records are written to the destination for a model sync. The modes array for a target object defines the id along with what operations the mode supports.

Authentication

AuthorizationBasic

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

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Polytomic-VersionstringRequired

Query parameters

include_target_creation_valuesbooleanOptionalDefaults to false

When true, inline the valid values for each enum target-creation property in the response. Skips the separate call to retrieve property values.

Response

OK
datalist of objects or nullOptional
target_creationobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error