Export configuration
get/admin/config
Returns the configuration for all of the types. This is intended to be used for moving the configuration between systems and as such there are no version numbers in the response.
1{2 "types": {3 "address": {4 "name": "address",5 "displayName": "Address",6 "category": "resolvedEntity",7 "options": {8 "dynamic": "true"9 },10 "config": {}11 },12 "business": {13 "name": "business",14 "displayName": "Business",15 "category": "resolvedEntity",16 "options": {17 "dynamic": "true"18 },19 "config": {}20 },21 "business_customers": {22 "name": "business_customers",23 "displayName": "Business Customer",24 "category": "entity",25 "fields": {26 "business_details_address": {27 "type": "object",28 "innerFields": {29 "address": {30 "displayName": "Address",31 "type": "text"32 },33 "city": {34 "displayName": "City",35 "type": "text",36 "options": {37 "features": []38 }39 },40 "postal_code": {41 "displayName": "Postal Code",42 "type": "text",43 "options": {44 "features": []45 }46 },47 "country": {48 "displayName": "Country",49 "type": "text",50 "options": {51 "features": []52 }53 },54 "geojson": {55 "displayName": "GeoJSON",56 "type": "geoShape"57 }58 }59 },60 "business_details_email": {61 "type": "object",62 "innerFields": {63 "email_address": {64 "displayName": "Email Address",65 "type": "text",66 "options": {67 "features": []68 }69 }70 }71 },72 "business_details_telephon": {73 "type": "object",74 "innerFields": {75 "phone_number": {76 "displayName": "Phone Number",77 "type": "text",78 "options": {79 "features": []80 }81 }82 }83 },84 "bus_cust_type": {85 "displayName": "Bus Cust Type",86 "type": "text",87 "options": {88 "features": []89 }90 },91 "business_incorporation_date": {92 "displayName": "Business Incorporation Date",93 "type": "date"94 },95 "business_primary_industry": {96 "displayName": "Business Primary Industry",97 "type": "double"98 },99 "business_registered_name": {100 "displayName": "Business Registered Name",101 "type": "text"102 },103 "business_registration_number": {104 "displayName": "Business Registration Number",105 "type": "double"106 },107 "cust_start_date": {108 "displayName": "Cust Start Date",109 "type": "date"110 },111 "customer_end_date": {112 "displayName": "Customer End Date",113 "type": "date"114 },115 "customer_id_number": {116 "displayName": "Customer ID Number",117 "type": "double"118 },119 "customer_name": {120 "displayName": "Customer Name",121 "type": "text"122 },123 "customer_risk_rating": {124 "displayName": "Customer Risk Rating",125 "type": "double"126 },127 "customer_type": {128 "displayName": "Customer Type",129 "type": "text",130 "options": {131 "features": []132 }133 }134 },135 "config": {136 "summary": {137 "fields": [138 "business_registration_number",139 "bus_cust_type",140 "customer_id_number",141 "customer_type"142 ],143 "highlighting": {144 "bus_cust_type": {145 "highlighter": "plain",146 "fragments": 3,147 "fragmentSize": 150148 },149 "business_registered_name": {150 "highlighter": "plain",151 "fragments": 3,152 "fragmentSize": 150153 },154 "customer_name": {155 "highlighter": "plain",156 "fragments": 3,157 "fragmentSize": 150158 },159 "customer_type": {160 "highlighter": "plain",161 "fragments": 3,162 "fragmentSize": 150163 }164 }165 },166 "table": {167 "fields": [168 "business_registration_number",169 "bus_cust_type",170 "business_incorporation_date",171 "customer_id_number",172 "customer_type"173 ]174 },175 "facets": [176 {177 "type": "terms",178 "field": "bus_cust_type",179 "limit": 100180 },181 {182 "type": "terms",183 "field": "customer_type",184 "limit": 100185 },186 {187 "type": "dateRange",188 "field": "business_incorporation_date",189 "accuracy": "day",190 "filter": {191 "allowExact": true,192 "allowRange": true,193 "fromType": "gte",194 "toType": "lte"195 },196 "ranges": []197 }198 ],199 "events": [200 {201 "fields": {202 "category": "business_incorporated",203 "label": "Business Incorporated",204 "description": "<br>Registration Number: {business_registration_number}",205 "pointTimestamp": "{business_incorporation_date}"206 }207 },208 {209 "root": "business_details_address",210 "fields": {211 "category": "business_address",212 "label": "{/business_registered_name}",213 "description": "<br>Registration Number: {/business_registration_number}<br>Address: {address}",214 "geoJson": "geojson"215 }216 },217 {218 "fields": {219 "category": "customer_start_date",220 "label": "Customer Start Date",221 "description": "<br>Name: {customer_name}<br>Type: {customer_type}",222 "pointTimestamp": "{cust_start_date}"223 }224 },225 {226 "fields": {227 "category": "customer_end_date",228 "label": "Customer End Date",229 "description": "<br>Name: {customer_name}<br>Type: {customer_type}",230 "pointTimestamp": "{customer_end_date}"231 }232 }233 ],234 "label": {235 "template": "Customer: {0}",236 "values": [237 "customer_name"238 ]239 },240 "description": {241 "template": "<br>Customer Id: {0}<br>Business Registration Number: {1}<br>Type: {2}<br>Risk Rating: {3}",242 "values": [243 "customer_id_number",244 "business_registration_number",245 "bus_cust_type",246 "customer_risk_rating"247 ]248 }249 }250 },251 "entityRelationship": {252 "name": "entityRelationship",253 "displayName": "Entity Relationship",254 "category": "entityRelationship"255 },256 "email": {257 "name": "email",258 "displayName": "Email",259 "category": "resolvedEntity"260 },261 "resolvedEntityRelationship": {262 "name": "resolvedEntityRelationship",263 "displayName": "Resolved Entity Link",264 "category": "resolvedEntityRelationship"265 },266 "individual": {267 "name": "individual",268 "displayName": "Individual",269 "category": "resolvedEntity",270 "config": {}271 },272 "individual_customers": {273 "name": "individual_customers",274 "displayName": "Individual Customers",275 "category": "entity",276 "fields": {277 "individual_details_addres": {278 "type": "object",279 "innerFields": {280 "address": {281 "displayName": "Address",282 "type": "text"283 },284 "city": {285 "displayName": "City",286 "type": "text",287 "options": {288 "features": []289 }290 },291 "postal_code": {292 "displayName": "Postal Code",293 "type": "text",294 "options": {295 "features": []296 }297 },298 "country": {299 "displayName": "Country",300 "type": "text",301 "options": {302 "features": []303 }304 },305 "geojson": {306 "displayName": "GeoJSON",307 "type": "geoShape"308 }309 }310 },311 "individual_details_email": {312 "type": "object",313 "innerFields": {314 "email_address": {315 "displayName": "Email Address",316 "type": "text",317 "options": {318 "features": []319 }320 }321 }322 },323 "individual_details_teleph": {324 "type": "object",325 "innerFields": {326 "phone_number": {327 "displayName": "Phone Number",328 "type": "text",329 "options": {330 "features": []331 }332 }333 }334 },335 "bus_cust_type": {336 "displayName": "Bus Cust Type",337 "type": "text",338 "options": {339 "features": []340 }341 },342 "cust_start_date": {343 "displayName": "Cust Start Date",344 "type": "date"345 },346 "customer_end_date": {347 "displayName": "Customer End Date",348 "type": "date"349 },350 "customer_id_number": {351 "displayName": "Customer ID Number",352 "type": "double"353 },354 "customer_name": {355 "displayName": "Customer Name",356 "type": "text"357 },358 "customer_risk_rating": {359 "displayName": "Customer Risk Rating",360 "type": "double"361 },362 "customer_status": {363 "displayName": "Customer Status",364 "type": "text"365 },366 "customer_type": {367 "displayName": "Customer Type",368 "type": "text",369 "options": {370 "features": []371 }372 },373 "date_of_birth": {374 "displayName": "Date Of Birth",375 "type": "date"376 },377 "full_name": {378 "displayName": "Full Name",379 "type": "text"380 },381 "personal_national_id_number": {382 "displayName": "Personal National ID Number",383 "type": "text",384 "options": {385 "features": []386 }387 }388 },389 "config": {390 "summary": {391 "fields": [392 "personal_national_id_number",393 "full_name",394 "customer_type",395 "customer_status",396 "customer_risk_rating"397 ],398 "highlighting": {399 "customer_name": {400 "highlighter": "plain",401 "fragments": 3,402 "fragmentSize": 150403 },404 "customer_type": {405 "highlighter": "plain",406 "fragments": 3,407 "fragmentSize": 150408 },409 "full_name": {410 "highlighter": "plain",411 "fragments": 3,412 "fragmentSize": 150413 }414 }415 },416 "table": {417 "fields": [418 "customer_name",419 "customer_type",420 "personal_national_id_number",421 "customer_risk_rating",422 "customer_status"423 ]424 },425 "facets": [426 {427 "type": "terms",428 "field": "bus_cust_type",429 "limit": 100430 },431 {432 "type": "terms",433 "field": "customer_type",434 "limit": 100435 },436 {437 "type": "dateRange",438 "field": "date_of_birth",439 "accuracy": "day",440 "filter": {441 "allowExact": true,442 "allowRange": true,443 "fromType": "gte",444 "toType": "lte"445 },446 "ranges": []447 }448 ],449 "events": [450 {451 "fields": {452 "category": "customer_dob",453 "label": "Customer Date of Birth",454 "description": "<br>Name: {customer_name}<br>Type: {customer_type}",455 "pointTimestamp": "{date_of_birth}"456 }457 },458 {459 "root": "individual_details_addres",460 "fields": {461 "category": "customer_address",462 "label": "Customer: {/customer_name}",463 "description": "<br>Name: {/customer_name}<br>Type: {/customer_type}",464 "geoJson": "geojson"465 }466 },467 {468 "fields": {469 "category": "customer_start_date",470 "label": "Customer Start Date",471 "description": "<br>Name: {customer_name}<br>Type: {customer_type}",472 "pointTimestamp": "{cust_start_date}"473 }474 },475 {476 "fields": {477 "category": "customer_end_date",478 "label": "Customer End Date",479 "description": "<br>Name: {customer_name}<br>Type: {customer_type}",480 "pointTimestamp": "{customer_end_date}"481 }482 }483 ],484 "label": {485 "template": "Customer: {0}",486 "values": [487 "customer_name"488 ]489 },490 "description": {491 "template": "National Id: {0} - Full Name: {1} - Type: {1} - Status: {2} - Risk Rating: {3}",492 "values": [493 "personal_national_id_number",494 "full_name",495 "customer_type",496 "customer_status",497 "customer_risk_rating"498 ]499 }500 }501 },502 "telephone": {503 "name": "telephone",504 "displayName": "Telephone",505 "category": "resolvedEntity"506 }507 },508 "links": [509 {510 "method": "GET",511 "rel": "self",512 "href": "/svi-sand/admin/config",513 "uri": "/svi-sand/admin/config",514 "type": "application/vnd.sas.sand.config"515 },516 {517 "method": "POST",518 "rel": "import",519 "href": "/svi-sand/admin/config",520 "uri": "/svi-sand/admin/config",521 "type": "application/vnd.sas.sand.config"522 },523 {524 "method": "DELETE",525 "rel": "delete",526 "href": "/svi-sand/admin/config",527 "uri": "/svi-sand/admin/config"528 },529 {530 "method": "GET",531 "rel": "getTypes",532 "href": "/svi-sand/admin/config/types",533 "uri": "/svi-sand/admin/config/types",534 "type": "application/vnd.sas.collection",535 "itemType": "application/vnd.sas.sand.type"536 }537 ]538}
Status | Meaning | Description | ||
---|---|---|---|---|
200 | OK | The request succeeded. | Schema |