Get Connection Target Fields

curl -X POST https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/target/fields \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "target": "sales.customers"
}'

{
  "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": "varchar",
        "supports_identity": true,
        "type": "string",
        "updateable": false
      },
      {
        "association": false,
        "createable": true,
        "description": "Customer's email address",
        "encryptable": true,
        "filterable": true,
        "id": "email",
        "identity_functions": [
          {
            "id": "Equality",
            "label": "Equality"
          },
          {
            "id": "HashedMatch",
            "label": "Hashed Match"
          }
        ],
        "name": "Email",
        "required": false,
        "source_type": "varchar",
        "supports_identity": true,
        "type": "string",
        "updateable": true
      },
      {
        "association": false,
        "createable": true,
        "description": "Date the customer was created",
        "encryptable": false,
        "filterable": true,
        "id": "created_at",
        "identity_functions": [],
        "name": "Created At",
        "required": false,
        "source_type": "timestamp",
        "supports_identity": false,
        "type": "datetime",
        "updateable": false
      },
      {
        "association": true,
        "createable": true,
        "description": "Reference to the customer's assigned sales representative",
        "encryptable": false,
        "filterable": true,
        "id": "sales_rep_id",
        "identity_functions": [],
        "name": "Sales Representative",
        "required": false,
        "source_type": "int",
        "supports_identity": false,
        "type": "integer",
        "updateable": true
      }
    ],
    "id": "sales.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; do not create new ones",
        "label": "Update",
        "mode": "update",
        "requires_identity": true,
        "supports_field_sync_mode": true,
        "supports_target_filters": true
      },
      {
        "description": "Create new records or update existing ones based on identity",
        "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": "Customer Table",
      "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": false
    },
    "refreshed_at": "2024-04-20T15:45:00Z"
  }
}

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

🚧 Deprecated

Use POST /api/connections/{id}/modelsync/target/fields 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"

Request

This endpoint expects an object.

targetstringRequired

refreshbooleanOptional

Response

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Get Connection Target Fields

Authentication

Path parameters

Headers

Request

Response

Errors

Authentication

Path parameters

Headers

Request

Response

Errors