Get Connection Target Fields

POST

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

POST

/api/connections/:id/target/fields

1 curl -X POST https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/target/fields \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "target": "database.table"
6 }'

Try it

1 {
2   "data": {
3     "fields": [
4       {
5         "association": false,
6         "createable": true,
7         "description": "Field description",
8         "encryptable": false,
9         "filterable": true,
10         "id": "field1",
11         "name": "Field",
12         "required": true,
13         "source_type": "string",
14         "supports_identity": false,
15         "type": "string",
16         "updateable": true
17       }
18     ],
19     "id": "database.table",
20     "modes": [
21       {
22         "description": "Create records when they don't exist; don't update existing ones",
23         "label": "Create",
24         "mode": "create",
25         "requires_identity": true,
26         "supports_field_sync_mode": false,
27         "supports_target_filters": false
28       }
29     ],
30     "name": "Table",
31     "properties": {
32       "does_not_report_operation_counts": true,
33       "mappings_not_required": true,
34       "new_target_label": "new_target_label",
35       "optional_target_mappings": true,
36       "primary_metadata_object": "primary_metadata_object",
37       "requires_configuration": true,
38       "supports_field_creation": true,
39       "supports_field_encryption": true,
40       "supports_field_type_selection": true,
41       "supports_identity_field_creation": true,
42       "supports_target_filters": true,
43       "target_creator": true,
44       "use_field_names_as_labels": true
45     },
46     "refreshed_at": "2024-01-01T00:00:00Z"
47   }
48 }

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

targetstringRequired

refreshbooleanOptional

Response

dataobject or null

Get Connection Target Fields

Authentication

Path parameters

Headers

Request

Response

Errors