Data Clinic API (1.0)

Download OpenAPI specification:Download

Sylwester Lew: sylwester.lew@cdq.com URL: https://www.cdq.com/team

This API provides services for Data Clinic

Augmented Business Partners

Read a Page of Augmented Business Partners

SecurityapiKey
Request
path Parameters
storageId
required
string
query Parameters
countryShortNames
Array of strings (CountryShortNameParam)

List of iso-2 country codes (see possible values here: Country - CDQ) for filtering business partners by country.

Items Enum: "AC" "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AP" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BU" "BV" "BW" "BX" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CP" "CQ" "CR" "CS" "CT" "CU" "CV" "CW" "CX" "CY" "CZ" "DD" "DE" "DG" "DJ" "DK" "DM" "DO" "DY" "DZ" "EA" "EC" "EE" "EF" "EG" "EH" "EM" "EP" "ER" "ES" "ET" "EU" "EV" "EW" "EZ" "FI" "FJ" "FK" "FL" "FM" "FO" "FQ" "FR" "FX" "GA" "GB" "GC" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "HV" "IB" "IC" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JA" "JE" "JM" "JO" "JP" "JT" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LF" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MI" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NH" "NI" "NL" "NO" "NP" "NQ" "NR" "NT" "NU" "NZ" "OA" "OM" "PA" "PC" "PE" "PF" "PG" "PH" "PI" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PU" "PW" "PY" "PZ" "QA" "RA" "RB" "RC" "RE" "RH" "RI" "RL" "RM" "RN" "RO" "RP" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SF" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SU" "SV" "SX" "SY" "SZ" "TA" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TP" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UK" "UM" "UN" "US" "UY" "UZ" "VA" "VC" "VD" "VE" "VG" "VI" "VN" "VU" "WF" "WG" "WK" "WL" "WO" "WORLD" "WS" "WV" "XI" "XK" "YD" "YE" "YT" "YU" "YV" "ZA" "ZM" "ZR" "ZW"
Example: countryShortNames=["DE", "FR"]
dataSourceId
string

The id of a data source of the data mirror for filtering only business partners that are managed in this source.

externalIds
Array of strings

List of external ids for filtering by a specific selection of business partners managed in the data mirror.

featuresOff
Array of strings (ReadAugmentedBusinessPartnersFeatureParam)

Feature(s) to be used during the read augmented business partners:

  • FETCH_RAW_UPDATES - Allows to switch fetching raw updates field to reduce data size. Result is available under $.values[*].updates in the result object. By default turned off.
  • FILTER_BY_ENABLED_AUGMENTATION_MONITORS - Filters out results by enabled, existing data sources of augmentation monitors. By default turned on.
  • SHOW_ORIGINAL_BUSINESS_PARTNER - Include business partner that was used as an input for curation in the result. By default turned off.
Items Enum: "FETCH_RAW_UPDATES" "FILTER_BY_ENABLED_AUGMENTATION_MONITORS" "SHOW_ORIGINAL_BUSINESS_PARTNER"
featuresOn
Array of strings (ReadAugmentedBusinessPartnersFeatureParam)

Feature(s) to be used during the read augmented business partners:

  • FETCH_RAW_UPDATES - Allows to switch fetching raw updates field to reduce data size. Result is available under $.values[*].updates in the result object. By default turned off.
  • FILTER_BY_ENABLED_AUGMENTATION_MONITORS - Filters out results by enabled, existing data sources of augmentation monitors. By default turned on.
  • SHOW_ORIGINAL_BUSINESS_PARTNER - Include business partner that was used as an input for curation in the result. By default turned off.
Items Enum: "FETCH_RAW_UPDATES" "FILTER_BY_ENABLED_AUGMENTATION_MONITORS" "SHOW_ORIGINAL_BUSINESS_PARTNER"
from
string

Filter records that were modified since the given date. Provide date in ISO XYZ format.

Example: from=2019-12-31T16:47
identifierCreated
boolean
identifierTypeTechnicalKeysCreated
Array of strings (IdentifierTypeTechnicalKey)

All identifier types for which the identifier value was ADDED

Example: identifierTypeTechnicalKeysCreated=CH_VAT_ID
identifierTypeTechnicalKeysUpdated
Array of strings (IdentifierTypeTechnicalKey)

All identifier types for which the identifier value was MODIFIED

Example: identifierTypeTechnicalKeysUpdated=CH_VAT_ID
identifierUpdated
boolean
legalFormCreated
boolean
legalFormUpdated
boolean
limit
integer <int32> [ 1 .. 100 ]
Default: 100

Define the maximum page size of the response.
See also CDQ - Developer Guidelines.

localAddressConceptsUpdated
Array of strings

All concepts of the local address that were MODIFIED or ADDED compared to the input address

localAddressCreated
boolean
localAddressUpdated
boolean

The given address that was not of type registered or VAT address comprises differences compared to the generated local address (value of one of the address concepts: locality, thoroughfare, etc. was MODIFIED or ADDED)

localNameCreated
boolean
localNameUpdated
boolean
overallClassifications
Array of strings (PropertyChangeClassification)
Example: overallClassifications=MAJOR
registeredAddressConceptsUpdated
Array of strings

All concepts of the registered address that were MODIFIED or ADDED

registeredAddressCreated
boolean
registeredAddressUpdated
boolean

Indicates whether given registered address was updated (one of the address concepts: locality, thoroughfare, etc. was MODIFIED or ADDED)

registeredNameCreated
boolean
registeredNameUpdated
boolean
startAfter
string

Start after the provided pagination ID. Leave empty for the first query. The response will contain a property nextStartAfter which need to be used for any subsequent queries until nextStartAfter is empty. See CDQ - Developer Guidelines.

triggerProvenanceTechnicalKeys
Array of strings (ProvenanceTechnicalKeyParam)

Filter business partners by the data sources that triggered the generation of a new version of the business partner. Possible values are

  • Data source prefixes (see all data source prefixes here: Data sources - CDQ)
  • ORGANIZATION
Items Enum: "AR_NRC" "AT_CR" "AT_FON" "AU_BR" "BR_RF" "BZST" "CA_CR" "CDQ_AA" "CDQ_BANKPOOL" "CDQ_CRS" "CDQ_CTRY" "CDQ_IDS" "CDQ_LF" "CDQ_POOL" "CH_MEDREG" "CH_UIDR" "CX_BPN" "CX_POOL" "CZ_REE" "DE_RC" "DK_CR" "DNB" "DNB_LINKAGE_LNKELI" "DNB_MASTER_DATA_BASIC" "DNB_MASTER_DATA_EXTENDED" "EE_CR" "FR_RC" "GB_EAW_CR" "GEON" "GMAPS" "GOOGLEPLACES" "GTRANSLATE" "HERE" "HK_CR" "IE_CR" "IL_CR" "IRS" "JP_CR" "LEI" "NL_BR" "NZ_CR" "ORGANIZATION" "OSM" "PL_NOBR" "RO_TR" "SAP" "SG_BR" "SK_FS" "UK_VAT" "USPS" "US_AK_BER" "US_CO_BER" "US_EDU" "US_FL_BER" "US_IO_BER" "US_LA_BER" "US_NY_BER" "US_OR_BER" "US_SEC" "US_SF_BER" "US_WA_BER" "VIES" "WIKIDATA"
Example: triggerProvenanceTechnicalKeys=["FR.RC", "VIES"]
triggerTypeTechnicalKeys
Array of strings (TriggerTypeTechnicalKeyParam)

Filter by the type of trigger for the generation of a new version of the business partner. Possible values are:

  • CREATED. Business partners that were newly created in the data mirror by the user and thus were considered the first time
  • UPDATED. Business partners that were modified in the data mirror by the user
  • REFERENCE_DATA_CHANGED. Business partners in the data mirror for which an update in activated data sources was identified resulting in the generation of a new version of the business partner
  • JOB.
Items Enum: "CREATED" "UPDATED" "REFERENCE_DATA_CHANGED" "JOB"
typeTechnicalKeys
Array of strings (BusinessPartnerTypeTechnicalKeyParam)

List of types used to filter the result of business partners returned. Possible values are:

  • LEGAL_ENTITY. Business partners that have a legal standing in the eyes of law. A legal entity has legal capacity to enter into agreements or contracts, assume obligations, incur and pay debts, sue and be sued in its own right, and to be held responsible for its actions.
  • ORGANIZATIONAL_UNIT. Business partners that have no legal standing in the eyes of law by its own, but are identifiable branches, divisions or subsidiaries of a legal entity.
  • BP_ADDRESS. An address that is treated as a dedicated business partner due to the fact of being used in business operations, e.g. a delivery recipient (ship to) or a bill-to address
Items Enum: "BP_ADDRESS" "BRAND" "LEGAL_ENTITY" "ORGANIZATIONAL_UNIT" "UNKNOWN"
Example: typeTechnicalKeys=BP_ADDRESS
vatAddressConceptsUpdated
Array of strings

All concepts of the VAT address that were MODIFIED or ADDED

vatAddressCreated
boolean
vatAddressUpdated
boolean

Indicates whether given VAT address was updated (one of the address concepts: locality, thoroughfare, etc. was MODIFIED or ADDED)

vatNameCreated
boolean
vatNameUpdated
boolean
Responses
200

OK

get/storages/{storageId}/augmentedbusinesspartners
Request samples 
Response samples 
application/json
{
  • "limit": 0,
  • "total": 0,
  • "startAfter": "string",
  • "nextStartAfter": "string",
  • "values": [
    ]
}
Read an Augmented Business Partner
SecurityapiKey 
Request 
path Parameters
dataSourceId
required
string
 
storageId
required
string
 
Request Body schema: application/json
required
externalId
required
string  non-empty 
Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.


 
featuresOn
Array of strings (FetchAugmentedBusinessPartnerFeatureParam) 
Feature(s) to be used during the fetch augmented business partner:


    

  • FETCH_RAW_UPDATES - Allows to switch fetching raw updates field to reduce data size. Result is available under $.updates in the result object. By default turned off.
    • 

  • SHOW_ORIGINAL_BUSINESS_PARTNER - Include business partner that was used as an input for curation in the result. By default turned off.
    • 



Items Enum: "FETCH_RAW_UPDATES" "SHOW_ORIGINAL_BUSINESS_PARTNER"  
from
string
Filter updates by date.


 
Responses 
200
OK


post/storages/{storageId}/datasources/{dataSourceId}/augmentedbusinesspartners/fetch
Request samples 
application/json
{
  • "externalId": "The ID managed in the customer's SAP systems.",
  • "from": "2019-12-31T16:47",
  • "featuresOn": [
    ]
}
Response samples 
application/json
{
  • "augmentedBusinessPartner": {},
  • "augmentedChanges": [
    ],
  • "requestSimilarity": {
    },
  • "updates": [
    ],
  • "executedAt": "string",
  • "metadata": {
    },
  • "resultSummary": {
    },
  • "originalBusinessPartner": {}
}