Get the configuration for a single type

get/admin/config/types/{type}
Internal-Use Only

Returns the configuration (including the current version number) for the specified type.

Request Samples

1

Response Samples

1{
2 "solution": "Insurance",
3 "name": "person",
4 "displayName": "Person",
5 "category": "entity",
6 "fields": {
7 "first_name": {
8 "displayName": "First Name",
9 "type": "text",
10 "options": {
11 "features": [
12 "search",
13 "sort"
14 ]
15 }
16 },
17 "last_name": {
18 "displayName": "Last Name",
19 "type": "text",
20 "options": {
21 "features": [
22 "search",
23 "facet",
24 "sort"
25 ]
26 }
27 },
28 "dob": {
29 "displayName": "Date of Birth",
30 "type": "date",
31 "options": {
32 "format": "strict_date_optional_time||epoch_millis"
33 }
34 },
35 "addresses": {
36 "displayName": "Addresses",
37 "type": "object",
38 "innerFields": {
39 "address": {
40 "displayName": "Address",
41 "type": "text"
42 },
43 "city": {
44 "displayName": "City",
45 "type": "text",
46 "options": {
47 "features": [
48 "facet"
49 ]
50 }
51 },
52 "areaCode": {
53 "displayName": "Area Code",
54 "type": "text",
55 "options": {
56 "features": []
57 }
58 },
59 "country": {
60 "displayName": "Country",
61 "type": "text",
62 "options": {
63 "features": []
64 }
65 },
66 "lat": {
67 "displayName": "Latitude",
68 "type": "double"
69 },
70 "lon": {
71 "displayName": "Longitude",
72 "type": "double"
73 }
74 }
75 }
76 },
77 "options": {
78 "number_of_replicas": 2
79 },
80 "config": {
81 "summary": {
82 "fields": [
83 "dob"
84 ],
85 "highlighting": {
86 "first_name": {
87 "highlighter": "plain",
88 "fragments": 3,
89 "fragmentSize": 50
90 },
91 "last_name": {
92 "highlighter": "plain",
93 "fragments": 3,
94 "fragmentSize": 50
95 }
96 }
97 },
98 "table": {
99 "fields": [
100 "first_name",
101 "last_name",
102 "dob"
103 ]
104 },
105 "facets": [
106 {
107 "type": "terms",
108 "field": "last_name",
109 "limit": 100
110 },
111 {
112 "type": "terms",
113 "field": "addresses.city",
114 "limit": 100
115 }
116 ],
117 "textAnalytics": {
118 "fields": [
119 "first_name",
120 "last_name"
121 ]
122 },
123 "events": [
124 {
125 "fields": {
126 "category": "birthday",
127 "label": "{first_name} {last_name}",
128 "description": "Born on {dob}",
129 "pointTimestamp": "{dob}"
130 }
131 },
132 {
133 "root": "addresses",
134 "fields": {
135 "category": "address",
136 "label": "{/first_name} {/last_name}",
137 "description": "Resides at {address} in {city}, {country}",
138 "latitude": "lat",
139 "longitude": "lon"
140 }
141 }
142 ],
143 "label": {
144 "template": "{0} {1}",
145 "values": [
146 "first_name",
147 "last_name"
148 ]
149 }
150 },
151 "links": [
152 {
153 "method": "GET",
154 "rel": "self",
155 "href": "/svi-sand/admin/config/types/person",
156 "uri": "/svi-sand/admin/config/types/person",
157 "type": "application/vnd.sas.sand.type"
158 },
159 {
160 "method": "PUT",
161 "rel": "update",
162 "href": "/svi-sand/admin/config/types/person",
163 "uri": "/svi-sand/admin/config/types/person",
164 "type": "application/vnd.sas.sand.type"
165 },
166 {
167 "method": "DELETE",
168 "rel": "delete",
169 "href": "/svi-sand/admin/config/types/person",
170 "uri": "/svi-sand/admin/config/types/person"
171 },
172 {
173 "method": "GET",
174 "rel": "up",
175 "href": "/svi-sand/admin/config/types",
176 "uri": "/svi-sand/admin/config/types",
177 "type": "application/vnd.sas.collection",
178 "itemType": "application/vnd.sas.sand.type"
179 }
180 ]
181}

Path Parameters

NameTypeRequiredDescription
type
string
true

The name of the type.

Responses

StatusMeaningDescription
200OKThe request succeeded.HeadersSchema
404Not FoundThe type does not exist.Schema