Read a page of Augmented Business Partners from a given storage.
conceptClassifications | Array of strings (UpdateClassificationTechnicalKeyEnum) Filter by specified concept Concept Classification Technical Keys. Example: conceptClassifications=MAJOR | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
countryShortNames | Array of strings (CountryShortNameParam) List of iso-2 country codes (see possible values here: Country - CDQ) for filtering Business Partners by country. Example: countryShortNames=DE | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dataSourceIds | Array of strings (BusinessPartnerStorageDataSourceId) List of IDs of Data Sources of the Data Mirror for filtering only Business Partners that are managed in these sources. Example: dataSourceIds=648824a691d8d2503d65103e | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
externalIds | Array of strings (BusinessPartnerExternalId) List of Business Partner External IDs for filtering by a specific selection of Business Partners managed in the Data Mirror. Example: externalIds=The ID managed in the customer's SAP systems. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
featuresOff | Array of strings (ReadAugmentedBusinessPartnersFeatureParam) Features to be deactivated during the read augmented Business Partners.
Example: featuresOff=FETCH_RAW_UPDATES | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
featuresOn | Array of strings (ReadAugmentedBusinessPartnersFeatureParam) Features to be activated during the read augmented Business Partners.
Example: featuresOn=FETCH_RAW_UPDATES | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (ModifiedFrom) Filter by records that were modified since the given date. Provide date in ISO format: Example: from=2025-07-14T21:15:59Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit | integer <int32> [ 1 .. 100 ] Default: 100 Define the maximum page size of the response. Example: limit=100 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
processingStatusTechnicalKey | string (ProcessingStatusTechnicalKeyEnum) Filter by the Processing Status of the Augmented Business Partner.
Example: processingStatusTechnicalKey=IN_PROGRESS | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. Example: startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
summaryClassifications | Array of strings (UpdateClassificationTechnicalKeyEnum) Filter by specified Summary Classification Technical Keys. Example: summaryClassifications=MAJOR | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | Array of strings (UpdateTagEnum) Filter by specified Update Summary Tags. Example: tags=IDENTIFIER_ADDED | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
triggerProvenanceTechnicalKeys | Array of strings (ProvenanceTechnicalKeyParam) Filter by the Data Sources that triggered the generation of a new version of the Augmented Business Partner.
Example: triggerProvenanceTechnicalKeys=CDQ_POOL | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
triggerTypeTechnicalKeys | Array of strings (TriggerTypeTechnicalKeyParam) Filter by the type of trigger for the generation of a new version of the Business Partner.
Example: triggerTypeTechnicalKeys=CREATED | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
typeTechnicalKeys | Array of strings (BusinessPartnerTypeTechnicalKeyParam) List of Business Partner Type Technical Keys for filtering by a specific selection of Business Partners managed in the Data Mirror. Example: typeTechnicalKeys=BP_ADDRESS |
OK
Bad Request
{- "limit": "100",
- "total": "67",
- "startAfter": "5712566172571652",
- "nextStartAfter": "5712566172571652",
- "values": [
- {
- "updatedBusinessPartner": {
- "dataSourceId": "648824a691d8d2503d65103e",
- "summary": {
- "tags": [
- "IDENTIFIER_ADDED"
], - "classification": {
- "technicalKey": "MAJOR",
- "reason": "The modified post code has deprecated format."
}
}, - "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "updateAssessment": {
- "action": {
- "technicalKey": null
}, - "classification": {
- "technicalKey": null,
- "reason": null
}, - "provenances": [
- null
], - "modifiedAt": "2025-07-14T21:15:59Z",
- "tags": [
- null
], - "before": {
- "type": null,
- "value": null,
- "shortName": null,
- "language": null
}, - "requestSimilarity": {
- "value": null
}
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "AG",
- "cdlElfCode": "AG",
- "categories": [
- {
- "name": "Limited Liability Company",
}
], - "updateAssessment": {
- "action": {
- "technicalKey": "ADDED"
}, - "classification": {
- "technicalKey": "MAJOR",
- "reason": "The modified post code has deprecated format."
}, - "provenances": [
- {
- "name": null,
- "url": null,
- "technicalKey": null,
- "cdqId": null
}
], - "modifiedAt": "2025-07-14T21:15:59Z",
- "tags": [
- "IDENTIFIER_ADDED"
], - "before": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": null,
- "technicalKey": null
}, - "mainAbbreviation": "AG",
- "cdlElfCode": "AG",
- "categories": [
- null
]
}
}
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": {
- "name": "Amtsgericht Aachen",
- "technicalKey": "Amtsgericht Aachen"
}, - "status": {
- "name": "ACTIVE",
- "technicalKey": "ACTIVE"
}, - "updateAssessment": {
- "action": {
- "technicalKey": null
}, - "classification": {
- "technicalKey": null,
- "reason": null
}, - "provenances": [
- null
], - "modifiedAt": "2025-07-14T21:15:59Z",
- "tags": [
- null
], - "before": {
- "type": null,
- "value": null,
- "issuingBody": null,
- "status": null
}
}
}
], - "categories": [
- {
- "name": "Hotel",
- "technicalKey": "HOTEL",
- "updateAssessment": {
- "action": {
- "technicalKey": null
}, - "classification": {
- "technicalKey": null,
- "reason": null
}, - "provenances": [
- null
], - "modifiedAt": "2025-07-14T21:15:59Z",
- "tags": [
- null
], - "before": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
}
], - "status": {
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}, - "officialDenotation": "Good Standing",
- "validFrom": "2025-07-14T21:15:59Z",
- "validUntil": "2025-07-14T21:15:59Z",
- "updateAssessment": {
- "action": {
- "technicalKey": "ADDED"
}, - "classification": {
- "technicalKey": "MAJOR",
- "reason": "The modified post code has deprecated format."
}, - "provenances": [
- {
- "name": null,
- "url": null,
- "technicalKey": null,
- "cdqId": null
}
], - "modifiedAt": "2025-07-14T21:15:59Z",
- "tags": [
- "IDENTIFIER_ADDED"
], - "before": {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "officialDenotation": "Good Standing",
- "validFrom": "2025-07-14T21:15:59Z",
- "validUntil": "2025-07-14T21:15:59Z"
}
}
}, - "addresses": [
- {
- "updateAssessment": {
- "provenances": [
- null
], - "curationAssessment": {
- "curationLevel": null,
- "accuracyIndicator": null,
- "outputLanguage": null,
- "curationDecision": null,
- "geographicCoordinatesAccuracy": null,
- "inputAddressType": null
}, - "requestSimilarity": {
- "value": null
}
}, - "version": {
- "language": {
- "name": null,
- "technicalKey": null
}, - "characterSet": {
- "name": null,
- "technicalKey": null
}
}, - "identifyingName": {
- "value": "John Doe"
}, - "externalId": "1",
- "careOf": {
- "value": "CDQ GmbH c/o Product Department"
}, - "contexts": [
- {
- "value": null
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland",
- "updateAssessment": {
- "action": null,
- "classification": null,
- "provenances": [ ],
- "modifiedAt": null,
- "tags": [ ],
- "before": null
}
}, - "administrativeAreas": [
- {
- "value": null,
- "fipsCode": null,
- "shortName": null,
- "type": null,
- "language": null,
- "updateAssessment": null
}
], - "postCodes": [
- {
- "value": null,
- "type": null,
- "updateAssessment": null
}
], - "localities": [
- {
- "type": null,
- "shortName": null,
- "value": null,
- "language": null,
- "updateAssessment": null
}
], - "thoroughfares": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "name": null,
- "direction": null,
- "language": null,
- "updateAssessment": null
}
], - "premises": [
- {
- "value": null,
- "shortName": null,
- "number": null,
- "type": null,
- "language": null,
- "updateAssessment": null
}
], - "postalDeliveryPoints": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "language": null,
- "updateAssessment": null
}
], - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275",
- "updateAssessment": {
- "action": null,
- "classification": null,
- "provenances": [ ],
- "modifiedAt": null,
- "tags": [ ],
- "before": null
}
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
]
}
], - "externalId": "The ID managed in the customer's SAP systems.",
- "profile": {
- "classifications": [
- {
- "value": "Manufacture of pesticides and other agrochemical products.",
- "code": "20.20Z",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "+41",
- "number": "71 571 10 40",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "value": "+41 71 571 10 40"
}
], - "contactEmails": [
- {
- "value": "developer-portal@cdq.com"
}
]
}, - "relations": [
- {
- "startedAt": "2025-07-14T21:15:59Z",
- "endedAt": "2025-07-14T21:15:59Z",
- "type": {
- "name": "Commercial ultimate",
- "technicalKey": "COMMERCIAL_ULTIMATE"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": {
- "externalId": "The ID managed in the customer's SAP systems.",
- "dataSourceId": "648824a691d8d2503d65103e"
}, - "endNode": {
- "externalId": "The ID managed in the customer's SAP systems.",
- "dataSourceId": "648824a691d8d2503d65103e"
}, - "deactivatedAt": "2025-07-14T21:15:59Z",
- "updateAssessment": {
- "action": {
- "technicalKey": null
}, - "classification": {
- "technicalKey": null,
- "reason": null
}, - "provenances": [
- null
], - "modifiedAt": "2025-07-14T21:15:59Z",
- "tags": [
- null
], - "before": {
- "startedAt": null,
- "endedAt": null,
- "type": null,
- "class": null,
- "startNode": null,
- "endNode": null,
- "deactivatedAt": null
}
}
}
], - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY",
- "updateAssessment": {
- "action": {
- "technicalKey": null
}, - "classification": {
- "technicalKey": null,
- "reason": null
}, - "provenances": [
- null
], - "modifiedAt": "2025-07-14T21:15:59Z",
- "tags": [
- null
], - "before": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
}
]
}, - "updates": [
- {
- "dataSourceId": "648824a691d8d2503d65103e",
- "summary": {
- "tags": [
- "IDENTIFIER_ADDED"
], - "classification": {
- "technicalKey": "MAJOR",
- "reason": "The modified post code has deprecated format."
}
}, - "names": [
- {
- "type": {
- "url": null,
- "name": null,
- "technicalKey": null
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": null,
- "technicalKey": null
}, - "updateAssessment": {
- "action": null,
- "classification": null,
- "provenances": [ ],
- "modifiedAt": null,
- "tags": [ ],
- "before": null,
- "requestSimilarity": null
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "AG",
- "cdlElfCode": "AG",
- "categories": [
- {
- "name": null,
- "url": null
}
], - "updateAssessment": {
- "action": {
- "technicalKey": null
}, - "classification": {
- "technicalKey": null,
- "reason": null
}, - "provenances": [
- null
], - "modifiedAt": "2025-07-14T21:15:59Z",
- "tags": [
- null
], - "before": {
- "name": null,
- "url": null,
- "technicalKey": null,
- "language": null,
- "mainAbbreviation": null,
- "cdlElfCode": null,
- "categories": [ ]
}
}
}, - "identifiers": [
- {
- "type": {
- "url": null,
- "name": null,
- "technicalKey": null
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": {
- "name": null,
- "technicalKey": null
}, - "status": {
- "name": null,
- "technicalKey": null
}, - "updateAssessment": {
- "action": null,
- "classification": null,
- "provenances": [ ],
- "modifiedAt": null,
- "tags": [ ],
- "before": null
}
}
], - "categories": [
- {
- "name": "Hotel",
- "technicalKey": "HOTEL",
- "updateAssessment": {
- "action": null,
- "classification": null,
- "provenances": [ ],
- "modifiedAt": null,
- "tags": [ ],
- "before": null
}
}
], - "status": {
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}, - "officialDenotation": "Good Standing",
- "validFrom": "2025-07-14T21:15:59Z",
- "validUntil": "2025-07-14T21:15:59Z",
- "updateAssessment": {
- "action": {
- "technicalKey": null
}, - "classification": {
- "technicalKey": null,
- "reason": null
}, - "provenances": [
- null
], - "modifiedAt": "2025-07-14T21:15:59Z",
- "tags": [
- null
], - "before": {
- "type": null,
- "officialDenotation": null,
- "validFrom": null,
- "validUntil": null
}
}
}, - "addresses": [
- {
- "updateAssessment": {
- "provenances": [ ],
- "curationAssessment": null,
- "requestSimilarity": null
}, - "version": {
- "language": null,
- "characterSet": null
}, - "identifyingName": {
- "value": null
}, - "externalId": "1",
- "careOf": {
- "value": null
}, - "contexts": [
- null
], - "country": {
- "shortName": null,
- "value": null,
- "updateAssessment": null
}, - "administrativeAreas": [
- null
], - "postCodes": [
- null
], - "localities": [
- null
], - "thoroughfares": [
- null
], - "premises": [
- null
], - "postalDeliveryPoints": [
- null
], - "geographicCoordinates": {
- "latitude": null,
- "longitude": null,
- "updateAssessment": null
}, - "types": [
- null
]
}
], - "externalId": "The ID managed in the customer's SAP systems.",
- "profile": {
- "classifications": [
- {
- "value": null,
- "code": null,
- "type": null
}
], - "phoneNumbers": [
- {
- "countryPrefix": null,
- "number": null,
- "type": null,
- "value": null
}
], - "websites": [
- {
- "url": null,
- "type": null
}
], - "contactEmails": [
- {
- "value": null
}
]
}, - "relations": [
- {
- "startedAt": "2025-07-14T21:15:59Z",
- "endedAt": "2025-07-14T21:15:59Z",
- "type": {
- "name": null,
- "technicalKey": null
}, - "class": {
- "name": null,
- "technicalKey": null
}, - "startNode": {
- "externalId": null,
- "dataSourceId": null
}, - "endNode": {
- "externalId": null,
- "dataSourceId": null
}, - "deactivatedAt": "2025-07-14T21:15:59Z",
- "updateAssessment": {
- "action": null,
- "classification": null,
- "provenances": [ ],
- "modifiedAt": null,
- "tags": [ ],
- "before": null
}
}
], - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY",
- "updateAssessment": {
- "action": null,
- "classification": null,
- "provenances": [ ],
- "modifiedAt": null,
- "tags": [ ],
- "before": null
}
}
]
}
], - "metadata": {
- "externalId": "The ID managed in the customer's SAP systems.",
- "executedAt": "2025-07-14T21:15:59Z",
- "country": {
- "shortName": "CH"
}, - "trigger": {
- "type": {
- "technicalKey": "PROCESSING_LOG"
}, - "provenance": {
- "technicalKey": "VIES"
}
}, - "processingStatus": {
- "technicalKey": "IN_PROGRESS",
- "modifiedAt": "2025-07-14T21:15:59Z"
}
}, - "originalBusinessPartner": {
- "externalId": "The ID managed in the customer's SAP systems.",
- "jsonRecord": "{ \"key\" : \"value\"}",
- "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "AG",
- "cdlElfCode": "AG",
- "categories": [
- {
- "name": "Limited Liability Company",
}
]
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": {
- "name": "Amtsgericht Aachen",
- "technicalKey": "Amtsgericht Aachen"
}, - "status": {
- "name": "ACTIVE",
- "technicalKey": "ACTIVE"
}
}
], - "categories": [
], - "status": {
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}, - "officialDenotation": "Good Standing",
- "validFrom": "2025-07-14T21:15:59Z",
- "validUntil": "2025-07-14T21:15:59Z"
}, - "profile": {
- "classifications": [
- {
- "value": "Manufacture of pesticides and other agrochemical products.",
- "code": "20.20Z",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "+41",
- "number": "71 571 10 40",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "value": "+41 71 571 10 40"
}
], - "contactEmails": [
- {
- "value": "developer-portal@cdq.com"
}
]
}, - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY"
}
], - "relations": [
- {
- "startedAt": "2025-07-14T21:15:59Z",
- "endedAt": "2025-07-14T21:15:59Z",
- "type": {
- "name": "Commercial ultimate",
- "technicalKey": "COMMERCIAL_ULTIMATE"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": {
- "externalId": "The ID managed in the customer's SAP systems.",
- "dataSourceId": "648824a691d8d2503d65103e"
}, - "endNode": {
- "externalId": "The ID managed in the customer's SAP systems.",
- "dataSourceId": "648824a691d8d2503d65103e"
}, - "deactivatedAt": "2025-07-14T21:15:59Z"
}
], - "addresses": [
- {
- "externalId": "1",
- "cdqId": "CDQID-123456789",
- "version": {
- "language": {
- "name": null,
- "technicalKey": null
}, - "characterSet": {
- "name": null,
- "technicalKey": null
}
}, - "identifyingName": {
- "value": "John Doe"
}, - "careOf": {
- "value": "CDQ GmbH c/o Product Department"
}, - "contexts": [
- {
- "value": null
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": null,
- "fipsCode": null,
- "shortName": null,
- "type": null,
- "language": null
}
], - "postCodes": [
- {
- "value": null,
- "type": null
}
], - "localities": [
- {
- "type": null,
- "shortName": null,
- "value": null,
- "language": null
}
], - "thoroughfares": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "name": null,
- "direction": null,
- "language": null
}
], - "premises": [
- {
- "value": null,
- "shortName": null,
- "number": null,
- "type": null,
- "language": null
}
], - "postalDeliveryPoints": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "language": null
}
], - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
]
}
]
}
}
], - "request": {
- "dataSourceIds": [
- "648824a691d8d2503d65103e"
], - "effectiveDataSourceIds": [
- "648824a691d8d2503d65103e"
], - "externalIds": [
- "The ID managed in the customer's SAP systems."
], - "typeTechnicalKeys": [
- "LEGAL_ENTITY"
], - "from": "2025-07-14T21:15:59Z",
- "countryShortNames": [
- "CH"
], - "triggerTypeTechnicalKeys": [
- "CREATED"
], - "triggerProvenanceTechnicalKeys": [
- "VIES"
], - "summaryClassifications": [
- "MAJOR"
], - "conceptClassifications": [
- "MAJOR"
], - "tags": [
- "IDENTIFIER_ADDED"
], - "featuresOn": [
- "FETCH_RAW_UPDATES"
], - "featuresOff": [
- "FETCH_RAW_UPDATES"
], - "effectiveFeatures": [
- "FETCH_RAW_UPDATES"
]
}
}