Export companies/contacts based on search
post
/api/v4/export
The export result is based on the export map attributes.
Full List of Contact Attributes: Contact Attributes
Versions Supported:
v4Full List of Company Attributes: Company Attributes
Full List of Contact Attributes: Contact Attributes
Request
Query Parameters
-
asynchronous(required): string
Default Value:
-
exportmapname(required): string
Mandatory. Map name should be provided. Gives output for the fields mentioned in the map.
-
format(required): string
Optional. Format of the file to be returned. The formats currently supported are TXT/JSON/XML/XLSX.When not passed, it takes default output format set by the admin.
-
includehierarchy(required): string
Optional. Parameter to export Company Hierarchy of the exported company. Takes Y/N for including/Not including company hierarchy in the exported file . When not passed, it takes N as the default value.Default Value:
N
-
jobdescription(required): string
Optional. Description of the job created. Takes a string value. When not passed, it takes exporting data as the default value.Default Value:
Exporting Data
-
jobname(required): string
Optional. Takes a string value. Takes the passed value as the name of the job that gets created when export is triggered. When not passed, it gets translated to an internal job name of the format: DAAS_COMPANY/CONTACT_EXPORT_TimeStamp.
Supported Media Types
- application/xml; charset=UTF-8
- application/json; charset=UTF-8
The SearchRequest entity holding the search request
Example XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <searchRequest> <facetLimit>10</facetLimit> <filterFields> <name>info.organization_name</name> <operator>EQ</operator> <value>oracle</value> </filterFields> <filterFields> <name>location.country</name> <operator>EQ</operator> <value>USA</value> </filterFields> <filterFields> <name>company.ees_total</name> <operator>GT</operator> <value>100</value> </filterFields> <filterFields> <name>company.sales_volume</name> <operator>LTE</operator> <value>150000000</value> </filterFields> <limit>10</limit> <objectType>Companies</objectType> <offset>0</offset> <orderByDirection>DESC</orderByDirection> <rangeFilters> <name>company.ees_total</name> <range> <from>2</from> <to>1000000</to> </range> </rangeFilters> <defaultFilters> <filterName>Defunct</filterName> </defaultFilters> <returnAll>false</returnAll> <returnFacets>location</returnFacets> <returnFacets>company.maj_ind_cg</returnFacets> <returnFields>location.country</returnFields> <returnFields>location.city</returnFields> <returnFields>company.maj_ind_cg</returnFields> </searchRequest>
Example JSON:
{ "facetLimit":"10", "filterFields":[{ "name":"info.organization_name", "operator":"EQ", "value":"oracle" }, { "name":"location.country", "operator":"EQ", "value":"USA" }, { "name":"company.ees_total", "operator":"GT", "value":"100" }, { "name":"company.sales_volume", "operator":"LTE", "value":"150000000" }], "limit":"10", "objectType":"Companies", "offset":"0", "orderByDirection":"DESC", "rangeFilters":{ "name":"company.ees_total", "range":{ "from":"2", "to":"1000000" } }, "defaultFilters" : [{ "filterName" : "Defunct" }], "returnAll":"false", "returnFacets":["location","company.maj_ind_cg"], "returnFields":["location.country","location.city","company.maj_ind_cg"] }
Root Schema : schema
Type:
Show Source
object
-
advancedSearch: object
AdvancedSearchFilters
-
defaultFilters: array
defaultFilters
-
exportCount: boolean
-
facetLimit: integer
(int32)
-
filterFields: array
filterFields
-
filterQuery: string
-
limit: integer
(int32)
-
mapName: string
-
objectType: string
Allowed Values:
[ "Companies", "People" ]
-
offset: integer
(int32)
-
orderBy: string
-
orderByDir: string
-
orderByDirection: string
Allowed Values:
[ "ASC", "DESC" ]
-
query: string
-
radialFilter: object
RadialFilter
-
rangeFilters: array
rangeFilters
-
returnAll: boolean
-
returnFacetFields: array
returnFacetFields
-
returnFacets: array
returnFacets
-
returnFields: array
returnFields
-
selectedFacets: array
selectedFacets
Nested Schema : RadialFilter
Type:
Show Source
object
-
countryName: string
-
isNotNullFlag: boolean
-
name: string
-
notNullFlag: boolean
-
operator: string
Allowed Values:
[ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
-
radius: string
-
unit: string
Allowed Values:
[ "km", "mi" ]
-
value: string
Nested Schema : AdvancedSearchFilterSet
Type:
Show Source
object
-
filterFields: array
filterFields
-
filterSetId: string
-
match: string
Allowed Values:
[ "ALL", "ANY" ]
-
rangeFilters: array
rangeFilters
Nested Schema : FilterInfo
Type:
Show Source
object
-
isNotNullFlag: boolean
-
name: string
-
notNullFlag: boolean
-
operator: string
Allowed Values:
[ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
-
value: string
Nested Schema : RangeFilterInfo
Type:
Show Source
object
-
isNotNullFlag: boolean
-
name: string
-
notNullFlag: boolean
-
operator: string
Allowed Values:
[ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
-
range: object
Range
-
value: string
Nested Schema : FacetFieldInfo
Type:
Show Source
object
-
limit: integer
(int32)
-
minCount: integer
(int32)
-
name: string
-
offset: integer
(int32)
-
sortBy: string
Allowed Values:
[ "count", "index" ]
The SearchRequest entity holding the search request
Example XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <searchRequest> <facetLimit>10</facetLimit> <filterFields> <name>info.organization_name</name> <operator>EQ</operator> <value>oracle</value> </filterFields> <filterFields> <name>location.country</name> <operator>EQ</operator> <value>USA</value> </filterFields> <filterFields> <name>company.ees_total</name> <operator>GT</operator> <value>100</value> </filterFields> <filterFields> <name>company.sales_volume</name> <operator>LTE</operator> <value>150000000</value> </filterFields> <limit>10</limit> <objectType>Companies</objectType> <offset>0</offset> <orderByDirection>DESC</orderByDirection> <rangeFilters> <name>company.ees_total</name> <range> <from>2</from> <to>1000000</to> </range> </rangeFilters> <defaultFilters> <filterName>Defunct</filterName> </defaultFilters> <returnAll>false</returnAll> <returnFacets>location</returnFacets> <returnFacets>company.maj_ind_cg</returnFacets> <returnFields>location.country</returnFields> <returnFields>location.city</returnFields> <returnFields>company.maj_ind_cg</returnFields> </searchRequest>
Example JSON:
{ "facetLimit":"10", "filterFields":[{ "name":"info.organization_name", "operator":"EQ", "value":"oracle" }, { "name":"location.country", "operator":"EQ", "value":"USA" }, { "name":"company.ees_total", "operator":"GT", "value":"100" }, { "name":"company.sales_volume", "operator":"LTE", "value":"150000000" }], "limit":"10", "objectType":"Companies", "offset":"0", "orderByDirection":"DESC", "rangeFilters":{ "name":"company.ees_total", "range":{ "from":"2", "to":"1000000" } }, "defaultFilters" : [{ "filterName" : "Defunct" }], "returnAll":"false", "returnFacets":["location","company.maj_ind_cg"], "returnFields":["location.country","location.city","company.maj_ind_cg"] }
Root Schema : schema
Type:
Show Source
object
-
advancedSearch: object
AdvancedSearchFilters
-
defaultFilters: array
defaultFilters
-
exportCount: boolean
-
facetLimit: integer
(int32)
-
filterFields: array
filterFields
-
filterQuery: string
-
limit: integer
(int32)
-
mapName: string
-
objectType: string
Allowed Values:
[ "Companies", "People" ]
-
offset: integer
(int32)
-
orderBy: string
-
orderByDir: string
-
orderByDirection: string
Allowed Values:
[ "ASC", "DESC" ]
-
query: string
-
radialFilter: object
RadialFilter
-
rangeFilters: array
rangeFilters
-
returnAll: boolean
-
returnFacetFields: array
returnFacetFields
-
returnFacets: array
returnFacets
-
returnFields: array
returnFields
-
selectedFacets: array
selectedFacets
Nested Schema : RadialFilter
Type:
Show Source
object
-
countryName: string
-
isNotNullFlag: boolean
-
name: string
-
notNullFlag: boolean
-
operator: string
Allowed Values:
[ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
-
radius: string
-
unit: string
Allowed Values:
[ "km", "mi" ]
-
value: string
Nested Schema : AdvancedSearchFilterSet
Type:
Show Source
object
-
filterFields: array
filterFields
-
filterSetId: string
-
match: string
Allowed Values:
[ "ALL", "ANY" ]
-
rangeFilters: array
rangeFilters
Nested Schema : FilterInfo
Type:
Show Source
object
-
isNotNullFlag: boolean
-
name: string
-
notNullFlag: boolean
-
operator: string
Allowed Values:
[ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
-
value: string
Nested Schema : RangeFilterInfo
Type:
Show Source
object
-
isNotNullFlag: boolean
-
name: string
-
notNullFlag: boolean
-
operator: string
Allowed Values:
[ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
-
range: object
Range
-
value: string
Nested Schema : FacetFieldInfo
Type:
Show Source
object
-
limit: integer
(int32)
-
minCount: integer
(int32)
-
name: string
-
offset: integer
(int32)
-
sortBy: string
Allowed Values:
[ "count", "index" ]
Response
Supported Media Types
- multipart/mixed; charset=UTF-8
200 Response
Success
Root Schema : schema
Type:
object
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 Requests:
/api/v4/export?exportmapname=SalesCloudCompanyExport_Release9&jobname=exportCompanies1&jobdescription=exportAllCompanieswithNamestartingwithOracle&includehierarchy=N /api/v4/export?exportmapname=CXCompanyExport&jobname=exportCompanies1&jobdescription=exportAllCompanieswithNamestartingwithOracle&includehierarchy=N
Example SearchRequest JSON Objects:
{"objectType":"Companies","query":"oracle","offset":"0","limit":"10","facetLimit":"0"} {"objectType":"People","offset":"0","limit":"10","facetLimit":"0"} {"objectType":"Companies","offset":"0","limit":"10","facetLimit":"0","filterFields":[{"name":"location.state","value":"CA"}]} {"objectType":"People","offset":"0","limit":"10","facetLimit":"0","defaultFilters":[{"filterName":"Enterprise Companies","filterValue":"N"},{"filterName":"Medium Companies","filterValue":"Y"},{"filterName":"Small Companies","filterValue":"Y"},{"filterName":"Defunct","filterValue":"Y"},{"filterName":"Out Of Business","filterValue":"Y"}]} {"objectType":"Companies","offset":"0","limit":"10","facetLimit":"0","defaultFilters":[{"filterName":"Enterprise Companies","filterValue":"Y"},{"filterName":"Medium Companies","filterValue":"Y"},{"filterName":"Small Companies","filterValue":"N"},{"filterName":"Defunct","filterValue":"Y"},{"filterName":"Out Of Business","filterValue":"N"}],"rangeFilters":[{"name":"company.sales_volume","range":{"from":"1000000","to":"999999999"}}]} {"objectType":"People","offset":"0","limit":"10","facetLimit":"0","selectedFacets":[{"name":"person.department", "value":"3" },{"name":"person.department", "value":"10" }],"orderBy":"location.state","orderByDir":"DESC"} {"objectType":"People","offset":"0","limit":"10","selectedFacets":[{ "name":"person.department", "value":"10" },{ "name":"location", "value":"USA" }],"orderBy":"location.country","orderByDir":"DESC","rangeFilters":[{"name":"location.postal_code","range":{"from":"30620","to":"80622"}}],"defaultFilters":[{"filterName":"Enterprise Companies","filterValue":"N"}]} {"objectType":"Companies","limit":"30","offset":"10","selectedFacets":[{ "name":"location", "value":"USA" },{"name":"company.primary_naics_cd","value":"11"}],"rangeFilters":[{"name":"location.postal_code","range":{"from":"30000","to":"80622"}}]}
Example Response:
Content-Type: application/json{"fileName":"exportCompanyCSVUsingCRMTemplate_TEST.txt","jobInstanceId":"22372","status":"COMPLETED","createdBy":"daas_admin1@oracle.com","modifiedBy":"daas_admin1@oracle.com","logExist":"false","jobDefinition":{"jobId":"22532","name":"exportCompanyCSVUsingCRMTemplate_TEST","type":"EXPORT","partyType":"COMPANY","description":"JobDesc","status":"ACTIVE","scheduleType":"IMMEDIATE","scheduleMode":"IMMEDIATE","createdBy":"daas_admin1@oracle.com","modifiedBy":"daas_admin1@oracle.com","searchType":"COMPANIES","autoImportEnabled":"N","jobMode":"Open Request","includeHierarchy":"N","client":"STANDALONE","exportJobParams":{"exportMapId":"10003","exportMapName":"SalesCloudCompanyExport_Release9","searchType":"COMPANIES","limit":"1","outputFormat":"TXT","offset":"0","orderBy":"id"},"createdOn":"2020-05-18 09:49:11.459844","modifiedOn":"2020-05-18 09:49:11.459844"},"createdOn":"2020-05-18 09:49:11.464197","modifiedOn":"2020-05-18 09:49:11.464197"}--Boundary_25_1956074832_1589795351587Content-Type: text/plainData/PartyId,Data/PartyOrigSystem,Data/PartyOrigSystemReference,Data/DataCloudStatus,Data/OrganizationName,Data/CurrencyCode,Data/CurrFyPotentialRevenue,Data/DomesticUltimateDunsNumC,Data/DunsNumberC,Data/GlobalUltimateDunsNumC,Data/ParentDunsNumC,Data/EmpAtPrimaryAdr,Data/EmpAtPrimaryAdrEstInd,Data/EmpAtPrimaryAdrMinInd,Data/EmployeesTotal,Data/TotalEmpEstInd,Data/TotalEmpMinInd,Data/ImportInd,Data/ExportInd,Data/LegalStatusCode,Data/LineOfBusiness,Data/MinorityOwnedInd,Data/MinorityOwnedType,Data/RentOwnInd,Data/PublicPrivateOwnershipFlag,Data/SmallBusInd,Data/StockSymbol,Data/ParentSubInd,Data/YearStarted,Data/LocationType,Data/NationalIdentificationNumber,Data/NationalIdentificationType,Data/IssuingAuthority,Data/FederalTaxIDNumber,Data/LaborSurplusIndicator,Data/PrimaryAddressLine1,Data/PrimaryAddressLine2,Data/PrimaryCity,Data/PrimaryCounty,Data/PrimaryState,Data/StateName,Data/PrimaryPostalCode,Data/PrimaryPostalPlus4Code,Data/PrimaryFullPostalCode,Data/PrimaryCountry,Data/Latitude,Data/LatitudeShort,Data/Longitude,Data/LongitudeShort,Data/PrimaryLocationOrigSystemReference,Data/PrimarySiteOrigSystemReference,Data/MailingAddressLine1,Data/MailingAddressLine2,Data/MailingCity,Data/MailingState,Data/MailingPostalCode,Data/MailingPostPlus4Code,Data/MailingFullPostalCode,Data/MailingCountry,Data/MailingLocationOrigSystemReference,Data/MailingSiteOrigSystemReference,Data/MailingSiteUseType,Data/PhoneCountryCode,Data/RawPhoneNumber,Data/PhoneOrigSystemReference,Data/FaxRawPhoneNumber,Data/FaxOrigSystemReference,Data/Url,Data/UrlOrigSystemReference,Data/WomanOwned,Data/AdditionalNameType1,Data/AdditionalName1,Data/AdditionalNameType2,Data/AdditionalName2,Data/AdditionalNameType3,Data/AdditionalName3,Data/AdditionalNameType4,Data/AdditionalName4,Data/AdditionalNameType5,Data/AdditionalName5,Data/MajorIndustryCategory,Data/MajorIndustryCategoryCode,Data/NAICSClassCategory1_1,Data/NAICSClassCode1_1,Data/NAICSClassCategory1_2,Data/NAICSClassCode1_2,Data/NAICSClassCategory1_3,Data/NAICSClassCode1_3,Data/NAICSClassCategory1_4,Data/NAICSClassCode1_4,Data/NAICSClassCategory2_1,Data/NAICSClassCode2_1,Data/NAICSClassCategory2_2,Data/NAICSClassCode2_2,Data/NAICSClassCategory2_3,Data/NAICSClassCode2_3,Data/NAICSClassCategory2_4,Data/NAICSClassCode2_4,Data/NAICSClassCategory3_1,Data/NAICSClassCode3_1,Data/NAICSClassCategory3_2,Data/NAICSClassCode3_2,Data/NAICSClassCategory3_3,Data/NAICSClassCode3_3,Data/NAICSClassCategory3_4,Data/NAICSClassCode3_4,Data/NAICSClassCategory4_1,Data/NAICSClassCode4_1,Data/NAICSClassCategory4_2,Data/NAICSClassCode4_2,Data/NAICSClassCategory4_3,Data/NAICSClassCode4_3,Data/NAICSClassCategory4_4,Data/NAICSClassCode4_4,Data/NAICSClassCategory5_1,Data/NAICSClassCode5_1,Data/NAICSClassCategory5_2,Data/NAICSClassCode5_2,Data/NAICSClassCategory5_3,Data/NAICSClassCode5_3,Data/NAICSClassCategory5_4,Data/NAICSClassCode5_4,Data/NAICSClassCategory6_1,Data/NAICSClassCode6_1,Data/NAICSClassCategory6_2,Data/NAICSClassCode6_2,Data/NAICSClassCategory6_3,Data/NAICSClassCode6_3,Data/NAICSClassCategory6_4,Data/NAICSClassCode6_4,Data/SICClassCategory1,Data/SICClassCode1,Data/SICClassCategory2,Data/SICClassCode2,Data/SICClassCategory3,Data/SICClassCode3,Data/SICClassCategory4,Data/SICClassCode4,Data/SICClassCategory5,Data/SICClassCode5,Data/SICClassCategory6,Data/SICClassCode6,MetaData/MatchScore,Data/CompanyDescription,Data/MarketableIndicator,Data/GEOCodeAccuracy,Data/SalesVolume(USDollars)ReliabilityCode,Data/Sales Volume (US Dollars),Data/SalesVolumeLocalCurrencyReliabilityCode,Data/DomesticUltimateBusinessName,Data/DomesticUltimateFIPSCountryCode,Data/DomesticUltimateD&BCountryCode,Data/DomesticUltimateState/ProvinceAbbreviation,Data/GlobalUltimateBusinessName,Data/GlobalUltimateIndicator,Data/GlobalUltimateFIPSCountryCode,Data/GlobalUltimateD&BCountryCode,Data/GlobalUltimateState/ProvinceAbbreviation,Data/HeadquarterDUNSNumber,Data/Parent/HeadquarterBusinessName,Data/HierarchyCode,Data/NumberofFamilyMembers,Data/OutofBusinessIndicator,Data/OvertheCounterStockExchange,Data/NYSEStockExchange,Data/ASETicker,Data/NMSTicker,Data/NASTicker,Data/OperatesFromResidenceIndicator,Data/PrimaryCompetitor1,Data/3YearGrowthPercentageonSalesVolume,Data/3YearGrowthPercentageonEmployees,Data/DelinquencyRisk,Data/CensusFIPSTerritoryCode,Data/CensusFIPSCountyCode,Data/BlogURL,Data/TwitterURL,Data/TwitterFollowers,Data/YouTubeURL,Data/YouTubeViews,Data/FacebookURL,Data/FacebookLikes,Data/FacebookShares,Data/PrimaryCompetitor2,Data/PrimaryCompetitor3,Data/SecondaryCompetitor1,Data/SecondaryCompetitor2,Data/GlobalExchangeName,Data/PrimaryIndicator,Data/NationalIdentificationCode,Data/FIPSMSACode,Data/ParentHeadquarterD&BCountryCode,Data/RecordStatus,Data/NewDUNSNumber,Data/Reason Recertification,Data/Date Recertification,Data/Maximum ARR(US Dollars),Data/Max Employees,Data/Domestic Max ARR(USD),Data/Domestic Max Employees,Data/ContactCount,DAAS,RE5CLDgxMjU1NjU2MSwxLDE=,ENRICHED,"America Movil, S.A.B. de C.V.",MXN,786101021000,812556561,812556561,812556561,,,Y,A,156250,Y,A,,,LSC/12,"Radiotelephone communication, nsk",,,G,,,AMXL,N,2000,HQ,AMO000925Q31,ID_NUMBER,ANY ID COMPANY,,,Lago Zurich No. 245 Edif. Telcel Piso 16,"Ampliacion Granada, Miguel Hidalgo",CIUDAD DE MEXICO,,D.F.,DISTRITO FEDERAL,11529,,11529,MX,19.441642,19.4416,-099.202967,-099.2029,RE5CLDgxMjU1NjU2MSwxLDE=1873958994_L,RE5CLDgxMjU1NjU2MSwxLDE=1873958994_S,,,,,,,,,,,,52,5525813700,RE5CLDgxMjU1NjU2MSwxLDE=446802816,5552584423,RE5CLDgxMjU1NjU2MSwxLDE=2039721313_F,,,,ALIAS,TELCEL,,,,,,,,,,,ORA_HZ_NAICS_2017,517210,,,,,,,ORA_HZ_NAICS_2017,551112,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,1987 SIC,4812,1987 SIC,6719,,,,,,,,,,"America Movil offers wireless phone service from the Rio Grande to Tierra del Fuego. The company is Latin America's top mobile carrier with more than 225 million subscribers in 18 countries. In Mexico the company enjoys a 70% market share with nearly 65 million subscribers to its Telcel brand, which has 260+ retail stores. Its second largest market is Brazil, which serves more than 50 million subscribers through Claro. America Movil also provides fixed-line service in Central America and the Caribbean, with more than 5 million lines. TracFone Wireless is America Movil's US presence. Majority owner Carlos Slim Helu combined America Movil with his fixed-line businesses Telmex in 2010 as part of a broader restructuring effort.",M,D,0,59711447454,,"America Movil, S.A.B. de C.V.",47,489,D.F.,"America Movil, S.A.B. de C.V.",Y,47,489,D.F.,812556561,"America Movil, S.A.B. de C.V.",01,2093,N,,,,,,,837568609,,,,,,,,,,,,,,812535367,462004128,216561930,812887982,"BOLSA MEXICANA DE VALORES, S.A. DE C.V.",Y,00230,,489,N,,,,59711447454,156250,59711447454,156250,0Back to Top