Get Connection Target Fields

Deprecated

POST

https://app.polytomic.com/api/connections/:id/target/fields

POST

/api/connections/:id/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": "database.table"
}'

{
  "data": {
    "fields": [
      {
        "association": false,
        "createable": true,
        "description": "Field description",
        "encryptable": false,
        "filter_functions": [
          {
            "id": "Equality",
            "label": "equals",
            "multi_value": false,
            "requires_value": true,
            "values": [
              {
                "depends_on": {},
                "label": "string",
                "value": "string"
              }
            ]
          }
        ],
        "filterable": true,
        "id": "field1",
        "identity_functions": [
          {
            "id": "Equality",
            "label": "Equality"
          }
        ],
        "multiple_associations": false,
        "name": "Field",
        "required": true,
        "source_type": "string",
        "supports_identity": false,
        "type": "string",
        "updateable": true,
        "values": [
          {
            "depends_on": {},
            "label": "string",
            "value": "string"
          }
        ]
      }
    ],
    "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,
      "identity_logics": [
        "string"
      ],
      "mappings_not_required": true,
      "new_target_label": "string",
      "optional_target_mappings": true,
      "primary_metadata_object": "string",
      "requires_configuration": true,
      "supports_field_creation": true,
      "supports_field_encryption": true,
      "supports_field_type_selection": true,
      "supports_filter_value_fields": true,
      "supports_identity_field_creation": true,
      "supports_multiple_identities": true,
      "supports_target_filters": true,
      "target_creator": true,
      "use_field_names_as_labels": true
    },
    "refreshed_at": "2024-01-01T00: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

dataobjectOptional

The target object and its fields

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors