Category:API endpoint

From CDQ
Jump to navigation Jump to search

Technical endpoints of the CDQ API.

EnpointShort DescriptionTechnical KeyAPI
Build Reference Data ReportsRequests the generation of reference data reports for a defined job resultREFERENCE_DATA_API_POST_REFERENCEDATAREPORTSReferencedata API
Clear StorageDelete all data in a CDQ Cloud storage.DATA_EXCHANGE_API_POST_STORAGES_STORAGEID_CLEARData Exchange API
Confirm ReliabilityConfirm reliabiltity of a given bank account.BANKACCOUNT_DATA_API_POST_BANKACCOUNTS_CONFIRMBankaccount Data API
Curate Business PartnerClense, enrich, and translate business partner and address data.DATA_CURATION_API_POST_BUSINESSPARTNERS_CURATEData Curation API
Delete Business PartnersDelete a business partner record in a CDQ Cloud storage.DATA_EXCHANGE_API_POST_STORAGES_STORAGEID_BUSINESSPARTNERS_DELETEData Exchange API
Delete a Data SourceDelete a complete data sourceDATA_EXCHANGE_API_DELETE_STORAGES_STORAGEID_DATASOURCES_DATASOURCEIDData Exchange API
Fetch DNB RecordRetrieve the full CMPELK for a given CDQ ID, optionally extended by its commercial ultimateREFERENCE_DATA_API_POST_DNB_BUSINESSPARTNERS_FETCHReferencedata API
Generate Golden RecordConsolidate the best information of a list of business partner records.DATA_CURATION_API_POST_BUSINESSPARTNERS_GOLDENRECORDS_GENERATEData Curation API
Lookup AddressFind address data by parts of an address, for auto-completion.REFERENCE_DATA_API_POST_ADDRESSES_LOOKUPReferencedata API
Lookup Business PartnerFind a business partner record in a CDQ Cloud storage.DATA_EXCHANGE_API_POST_STORAGES_STORAGEID_BUSINESSPARTNERS_LOOKUPData Exchange API
Lookup Business PartnerFind a business partner record in the CDQ Data Pool.REFERENCE_DATA_API_POST_BUSINESSPARTNERS_LOOKUPReferencedata API
MetricsLists all of existing KPIs in e2e database with some basic statistics about each of the KPI.QUERY_API_GET_METRICSAnalytics Query API
Metrics/valuesReturns back the details about each requested metric name.QUERY_API_GET_METRICS_VALUESAnalytics Query API
Model/runRuns machine learning model defined in payloadMACHINE_LEARNING_API_POST_MODEL_RUNMachine Learning API
Model/{id}Provides the status about the machine learning model progress. If the progress is set to FINISH, the endpoint call will return also the results of the machine learning model at JSON path results.[*]MACHINE_LEARNING_API_GET_MODELMachine Learning API
Read Business PartnerRead a business partner record in a CDQ Cloud storage.DATA_EXCHANGE_API_GET_STORAGES_STORAGEID_BUSINESSPARTNERS_IDData Exchange API
Read Business Partner UpdatesGet updates for business partner data in a CDQ Cloud Storage.DATA_EXCHANGE_API_GET_STORAGES_STORAGEID_BUSINESSPARTNERSData Exchange API
Read Business PartnersRead a set of business partner records in a CDQ Cloud storage, paged, optionally by country code.DATA_EXCHANGE_API_GET_STORAGES_STORAGEID_BUSINESSPARTNERSData Exchange API
Read DNB Lookup Job ResultsRetrieve DNB match results for a batch lookup jobREFERENCE_DATA_API_GET_READ_DNB_LOOKUP_JOB_RESULTSReferencedata API
Read DNB RecordsRead CMPELK records from a D&B storageDATA_EXCHANGE_API_GET_DNBSTORAGES_DNBRECORDSData Exchange API
Screen Compliance ListsFind matches for a business partner record in embargoes and sanctions lists.DATA_COMPLIANCE_API_POST_COMPLIANCELISTS_SCREENData Compliance API
Start DNB Import JobImport CMPELK records into a D&B storageDATA_EXCHANGE_API_POST_JOBS_DNBIMPORTJOBSData Exchange API
Start DNB Lookup JobRetrieve DNB records for the input data managed in a storageREFERENCE_DATA_API_POST_DNB_LOOKUPJOBSReferencedata API
Start Import JobImporting a file into a storage (e.g. data source in a data mirror)DATA_EXCHANGE_API_POST_JOBS_IMPORTJOBSData Exchange API
Upsert Business PartnersAdd or update a business partner record in a CDQ Cloud storage.DATA_EXCHANGE_API_PUT_STORAGES_STORAGEID_BUSINESSPARTNERSData Exchange API
Validate Business PartnerCheck a businesss partner record against CDQ data quality rules.DATA_VALIDATION_API_POST_BUSINESSPARTNERS_VALIDATEData Validation API
Validate RecordCheck a custom record against data quality rules.DATA_VALIDATION_API_POST_RECORDS_VALIDATEData Validation API