Get Sync Target Fields | Polytomic Docs

curl -G https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/target/fields \
     -H "X-Polytomic-Version: 2024-02-08" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d target=public.customers \
     -d refresh=false

{
  "data": {
    "fields": [
      {
        "association": false,
        "createable": true,
        "description": "Unique identifier for the customer",
        "encryptable": false,
        "filterable": true,
        "id": "customer_id",
        "identity_functions": [
          {
            "id": "Equality",
            "label": "Equality"
          }
        ],
        "name": "Customer ID",
        "required": true,
        "source_type": "uuid",
        "supports_identity": true,
        "type": "uuid",
        "updateable": false
      },
      {
        "association": false,
        "createable": true,
        "description": "Customer's full name",
        "encryptable": false,
        "filterable": true,
        "id": "full_name",
        "name": "Full Name",
        "required": true,
        "source_type": "string",
        "supports_identity": false,
        "type": "string",
        "updateable": true
      },
      {
        "association": false,
        "createable": true,
        "description": "Customer's email address",
        "encryptable": true,
        "filterable": true,
        "id": "email",
        "name": "Email",
        "required": true,
        "source_type": "string",
        "supports_identity": false,
        "type": "string",
        "updateable": true
      },
      {
        "association": false,
        "createable": true,
        "description": "Date the customer was created",
        "encryptable": false,
        "filterable": true,
        "id": "created_at",
        "name": "Created At",
        "required": true,
        "source_type": "timestamp",
        "supports_identity": false,
        "type": "timestamp",
        "updateable": false
      }
    ],
    "id": "public.customers",
    "modes": [
      {
        "description": "Create records when they don't exist; don't update existing ones",
        "label": "Create",
        "mode": "create",
        "requires_identity": true,
        "supports_field_sync_mode": false,
        "supports_target_filters": false
      },
      {
        "description": "Update existing records based on identity fields",
        "label": "Update",
        "mode": "update",
        "requires_identity": true,
        "supports_field_sync_mode": true,
        "supports_target_filters": true
      },
      {
        "description": "Create or update records based on identity fields",
        "label": "Upsert",
        "mode": "upsert",
        "requires_identity": true,
        "supports_field_sync_mode": true,
        "supports_target_filters": true
      }
    ],
    "name": "Customers",
    "properties": {
      "does_not_report_operation_counts": false,
      "mappings_not_required": false,
      "new_target_label": "New Customer Record",
      "optional_target_mappings": false,
      "primary_metadata_object": "customer_metadata",
      "requires_configuration": false,
      "supports_field_creation": true,
      "supports_field_encryption": true,
      "supports_field_type_selection": true,
      "supports_identity_field_creation": true,
      "supports_target_filters": true,
      "target_creator": false,
      "use_field_names_as_labels": true
    },
    "refreshed_at": "2024-04-20T15:45:00Z"
  }
}

Returns the fields of a specific target object on a connection.

Pass the target object identifier to retrieve the fields available for mapping on that object. These are the destination fields you can reference when configuring field mappings in a model sync.

📘 To list available target objects and their identifiers, use GET /api/connections/{id}/modelsync/targetobjects.

Fields returned here reflect the connection’s current cached state. If the upstream object schema has changed, trigger a schema refresh with POST /api/connections/{id}/schemas/refresh before calling this endpoint.

Returns the fields of a specific target object on a connection. Pass the target object identifier to retrieve the fields available for mapping on that object. These are the destination fields you can reference when configuring field mappings in a model sync. > 📘 To list available target objects and their identifiers, use > [`GET /api/connections/{id}/modelsync/targetobjects`](../../../../../../api-reference/model-sync/targets/list). Fields returned here reflect the connection's current cached state. If the upstream object schema has changed, trigger a schema refresh with [`POST /api/connections/{id}/schemas/refresh`](../../../../../../api-reference/schemas/refresh) before calling this endpoint.

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

targetstringRequired

Identifier of the target object (e.g. schema.table for a database destination, object name for a SaaS destination).

refreshbooleanOptional

When true, force a cache refresh of the target's schema before returning its fields.

Response

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors