Get default admin settings
get
/api/{version}/admin/defaults
This returns default mappings, search filters, and export file format.
Versions Supported:
v4
Request
Path Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success
Nested Schema : DefaultAdvFiltersInfo
Type:
Show Source
object
-
filterFields(optional):
array filterFields
-
objectType(optional):
string
Allowed Values:
[ "COMPANY", "CONTACT" ]
-
radialFilter(optional):
object RadialFilter
-
rangeFilters(optional):
array rangeFilters
Nested Schema : RadialFilter
Type:
Show Source
object
-
countryName(optional):
string
-
isNotNullFlag(optional):
boolean
-
name(optional):
string
-
notNullFlag(optional):
boolean
-
operator(optional):
string
Allowed Values:
[ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
-
radius(optional):
string
-
unit(optional):
string
Allowed Values:
[ "km", "mi" ]
-
value(optional):
string
Nested Schema : FilterInfo
Type:
Show Source
object
-
isNotNullFlag(optional):
boolean
-
name(optional):
string
-
notNullFlag(optional):
boolean
-
operator(optional):
string
Allowed Values:
[ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
-
value(optional):
string
Nested Schema : RangeFilterInfo
Type:
Show Source
object
-
isNotNullFlag(optional):
boolean
-
name(optional):
string
-
notNullFlag(optional):
boolean
-
operator(optional):
string
Allowed Values:
[ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
-
range(optional):
object Range
-
value(optional):
string
404 Response
Requested resource could not be found.
Root Schema : schema
Type:
object
500 Response
An unexpected error occurred during the request.
Root Schema : schema
Type:
object
Examples
Example Request:
/api/v4/admin/defaults
Example Response:
{ "defaultFilters": [ { "filterName": "CompanyInBusiness", "filterValue":"Y" }, { "filterName": "Enterprise Companies", "filterValue":"Y" }, { "filterName": "Defunct", "filterValue":"N" } ], "defaultMaps": [ { "mapMode": "CRM_STANDARD", "mapName": "CXContactExport", "mapType": "EXPORT", "objectType": "CONTACT" }, { "mapMode": "CRM_STANDARD", "mapName": "CXCompanyExport", "mapType": "EXPORT", "objectType": "COMPANY" }, { "mapMode": "CRM_STANDARD", "mapName": "CXContactMatch", "mapType": "ENRICH", "objectType": "CONTACT" }, { "mapMode": "CRM_STANDARD", "mapName": "CXCompanyMatch", "mapType": "ENRICH", "objectType": "COMPANY" } ] "defaultOutputFormat": "TXT" }Back to Top