Get Sync Target Fields | Polytomic Docs

import { PolytomicClient } from "polytomic";
const client = new PolytomicClient({ token: "YOUR_TOKEN", version: "YOUR_VERSION" });
await client.modelSync.targets.getTargetFields("248df4b7-aa70-47b8-a036-33ac447e668d", {
    target: "database.table",
    refresh: false
});

{
  "data": {
    "fields": [
      {
        "association": false,
        "createable": true,
        "description": "Field description",
        "encryptable": false,
        "filterable": true,
        "id": "field1",
        "name": "Field",
        "required": true,
        "source_type": "string",
        "supports_identity": false,
        "type": "string",
        "updateable": true
      }
    ],
    "id": "database.table",
    "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
      }
    ],
    "name": "Table",
    "properties": {
      "does_not_report_operation_counts": true,
      "mappings_not_required": true,
      "new_target_label": "new_target_label",
      "optional_target_mappings": true,
      "primary_metadata_object": "primary_metadata_object",
      "requires_configuration": true,
      "supports_field_creation": true,
      "supports_field_encryption": true,
      "supports_field_type_selection": true,
      "supports_identity_field_creation": true,
      "supports_target_filters": true,
      "target_creator": true,
      "use_field_names_as_labels": true
    },
    "refreshed_at": "2024-01-01T00:00:00Z"
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

targetstringRequired

refreshbooleanOptional

Response

dataobject

Errors

401

Targets Get Target Fields Request Unauthorized Error

403

Targets Get Target Fields Request Forbidden Error

404

Targets Get Target Fields Request Not Found Error

500

Targets Get Target Fields Request Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors