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": "integer",
        "supports_identity": true,
        "type": "integer",
        "updateable": false
      },
      {
        "association": false,
        "createable": true,
        "description": "Customer's full name",
        "encryptable": false,
        "filterable": true,
        "id": "full_name",
        "identity_functions": [],
        "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",
        "identity_functions": [
          {
            "id": "Equality",
            "label": "Equality"
          }
        ],
        "name": "Email",
        "required": true,
        "source_type": "string",
        "supports_identity": true,
        "type": "string",
        "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 based on identity fields",
        "label": "Update",
        "mode": "update",
        "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 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": true
    },
    "refreshed_at": "2024-04-20T12:00: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

Authentication

Path parameters

Headers

Request

Response

Errors