Preview Model

POST

Query parameters

asyncbooleanOptional

Request

This endpoint expects an object.

configurationmap from strings to anyRequired

connection_idstringRequired

namestringRequired

additional_fieldslist of objectsOptional

enricherobjectOptional

fieldslist of stringsOptional

identifierstringOptional

labelslist of stringsOptional

organization_idstringOptional

policieslist of stringsOptional

relationslist of objectsOptional

tracking_columnslist of stringsOptional

Response

This endpoint returns an object

dataobjectOptional

jobobjectOptional

POST

1 curl -X POST https://app.polytomic.com/api/model-preview \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "configuration": {
6     "table": "public.users"
7   },
8   "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
9   "name": "Users"
10 }'

200Successful

1 {
2   "data": {
3     "configuration": {
4       "table": "public.contacts"
5     },
6     "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
7     "enricher": {
8       "configuration": {
9         "key": "value"
10       },
11       "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
12       "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
13       "fields": [
14         {
15           "description": "Unique identifier",
16           "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
17           "label": "ID",
18           "name": "phone_number",
19           "remote_type": "string",
20           "type": "string",
21           "unique": true,
22           "user_added": false
23         }
24       ],
25       "mappings": {
26         "key": "value"
27       }
28     },
29     "fields": [
30       {
31         "description": "Unique identifier",
32         "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
33         "label": "ID",
34         "name": "id",
35         "remote_type": "string",
36         "type": "string",
37         "unique": true,
38         "user_added": false
39       }
40     ],
41     "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
42     "identifier": "id",
43     "labels": [
44       {
45         "key": "value"
46       }
47     ],
48     "name": "Contacts",
49     "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
50     "policies": [
51       "248df4b7-aa70-47b8-a036-33ac447e668d"
52     ],
53     "relations": [
54       {
55         "from": "id"
56       }
57     ],
58     "tracking_columns": [
59       "tracking_columns"
60     ],
61     "type": "postgresql",
62     "version": 1
63   },
64   "job": {
65     "error": "error message",
66     "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
67     "result": {
68       "key": "value"
69     },
70     "status": "created",
71     "type": "createmodel"
72   }
73 }

1	curl -X POST https://app.polytomic.com/api/model-preview \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"configuration": {
6	"table": "public.users"
7	},
8	"connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
9	"name": "Users"
10	}'

1	{
2	"data": {
3	"configuration": {
4	"table": "public.contacts"
5	},
6	"connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
7	"enricher": {
8	"configuration": {
9	"key": "value"
10	},
11	"connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
12	"enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
13	"fields": [
14	{
15	"description": "Unique identifier",
16	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
17	"label": "ID",
18	"name": "phone_number",
19	"remote_type": "string",
20	"type": "string",
21	"unique": true,
22	"user_added": false
23	}
24	],
25	"mappings": {
26	"key": "value"
27	}
28	},
29	"fields": [
30	{
31	"description": "Unique identifier",
32	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
33	"label": "ID",
34	"name": "id",
35	"remote_type": "string",
36	"type": "string",
37	"unique": true,
38	"user_added": false
39	}
40	],
41	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
42	"identifier": "id",
43	"labels": [
44	{
45	"key": "value"
46	}
47	],
48	"name": "Contacts",
49	"organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
50	"policies": [
51	"248df4b7-aa70-47b8-a036-33ac447e668d"
52	],
53	"relations": [
54	{
55	"from": "id"
56	}
57	],
58	"tracking_columns": [
59	"tracking_columns"
60	],
61	"type": "postgresql",
62	"version": 1
63	},
64	"job": {
65	"error": "error message",
66	"job_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
67	"result": {
68	"key": "value"
69	},
70	"status": "created",
71	"type": "createmodel"
72	}
73	}