Get Sync Target Fields

GET

1 curl -G https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/modelsync/target/fields \
2      -H "Authorization: Bearer <token>" \
3      -d target=database.table \
4      -d refresh=false

Play

200Retrieved

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

Path parameters

idstringRequired

Query parameters

targetstringRequired

refreshbooleanOptional

Response

dataobjectOptional

Get Sync Target Fields

Path parameters

Headers

Query parameters

Response

Errors