HTTP Enrichment | Polytomic Docs

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED	READONLY
url	string		true	false
method	string	Accepted Values: GET, POST	false	false
headers	array		false	false
parameters	array		false	false
body	string		false	false
healthcheck	string	Path to request when checking the health of this connection. No health check will be performed if left empty.	false	false
auth	object		false	false
inputMappings	array	List of input mappings to be used in the query. Each mapping should be a valid JSONPath expression.	false	false
fields	array	List of fields to be returned by the enrichment	false	false

Example

1 {
2   "name": "httpenrichment connection",
3   "type": "httpenrichment",
4   "configuration": {
5     "auth": {
6         "basic": {
7             "password": "secret",
8             "username": "user@example.com"
9         },
10         "header": {
11             "name": "foo",
12             "value": ""
13         },
14         "oauth": {
15             "auth_style": 0,
16             "client_id": "client_id",
17             "client_secret": "client_secret",
18             "extra_form_data": [
19                 {
20                     "name": "foo",
21                     "value": ""
22                 }
23             ],
24             "scopes": [
25                 {}
26             ],
27             "token_endpoint": "https://example.com/oauth/token"
28         }
29     },
30     "body": "{\"key\":\"value\"}",
31     "fields": [
32         {
33             "name": "",
34             "path": "",
35             "type": ""
36         }
37     ],
38     "headers": [
39         {
40             "name": "foo",
41             "value": ""
42         }
43     ],
44     "healthcheck": "https://example.com/healthz",
45     "inputMappings": [
46         {
47             "name": "",
48             "required": false,
49             "type": ""
50         }
51     ],
52     "method": "",
53     "parameters": [
54         {
55             "name": "foo",
56             "value": ""
57         }
58     ],
59     "url": "https://example.com"
60   }
61 }

Model Sync

Enrichment

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED	READONLY
object	string		false	false

Example

1 {
2   ...
3   "configuration": {
4     "object": ""
5   }
6 }