Referencedata API
API/Referencedata API
Jump to navigation
Jump to search
| Name Name of a concept, e.g. a data model concept. In contrast to terms, the name does not depend on a given context, e.g. a country-specific language. | Referencedata API |
|---|---|
| Short description Informal and short human-readable definition of a concept. | Services to search and read reference data. |
| Description Informal and comprehensive human-readable definition of a concept. | missing |
| Technical key Defines a unique key by which e.g. data model concepts can be referenced in a technical integration context. These keys are unique in the CDL context. | API_REFERENCE_DATA
|
| API Documentation | https://www.apimatic.io/apidocs/referencedata |
| WSDL Download | https://www.apimatic.io/apidocs/referencedata/v/3 0#/rest/guides/soap-reference |
API endpoints
This is just a selection of endpoints, most relevant ones from business perspective, without version information or other details. For a complete technical documentation of the endpoints, please go to the technical API documentation.
| Endpoint | Technical Key | Documentation |
|---|---|---|
| Build Reference Data Reports | REFERENCE_DATA_API_POST_REFERENCEDATAREPORTS | https://www.apimatic.io/apidocs/referencedata/v/3 0#/rest/api-endpoints/analytics/build-reference-data-reports |
| Fetch DNB Record | REFERENCE_DATA_API_POST_DNB_BUSINESSPARTNERS_FETCH | https://www.apimatic.io/apidocs/referencedata/v/3 0#/rest/api-endpoints/business-partners/fetch-dnb-record |
| Lookup Address | REFERENCE_DATA_API_POST_ADDRESSES_LOOKUP | https://www.apimatic.io/apidocs/referencedata/v/3 0#/rest/api-endpoints/adresses/lookup-address |
| Lookup Business Partner | REFERENCE_DATA_API_POST_BUSINESSPARTNERS_LOOKUP | https://www.apimatic.io/apidocs/referencedata/v/3 0#/rest/api-endpoints/business-partners/lookup-business-partners |
| Start DNB Lookup Job | REFERENCE_DATA_API_POST_DNB_LOOKUPJOBS | https://www.apimatic.io/apidocs/referencedata/v/3 0#/rest/api-endpoints/batch-lookup/start-dnb-lookup-job |
API feature toggles
No feature flags documented
Use cases
| Use case | Short Description |
|---|---|
| Business Partner Data Maintenance Workflow | Sequence of data maintenance steps for a single business partner data record. |
| Business Partner Data Maintenance Workflow | Sequence of data maintenance steps for a single business partner data record. |
| Business Partner Data Maintenance Workflow (Lean Create) | Sequence of data maintenance steps for creating a new single business partner data record in a local system such as SAP. |
| Dun & Bradstreet Batch Lookup Evaluation | Search for a batch of business partner records a number of candidate matches in the databases of Dun & Bradstreet |
| Dun & Bradstreet Commercial Ultimate Enrichment in Data Maintenance Workflows | |
| Dun & Bradstreet DUNS record linkage and CMPELK retrieval | Sequence of activities for enriching DUNS numbers which then allow for later retrieval of CMPELK data from D&B or setting up update monitoring via D&B |
| Dun & Bradstreet Lookup in Data Maintenance Workflows | |
| Duplicate avoidance in the business partner data maintenance workflow | Sequence of steps that are required for identifying duplicates using the CDQ Services in a business partner data maintenance workflow |
| Enrich DUNS Information from Dun & Bradstreet | Sequence of activities for enriching DUNS numbers and retrieval of CMPELK data from D&B, in batch and workflow mode. |