After you have started a transformation job, you will receive a job id in the response.
{
"id" : "<ID>"
}
Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED the transformation is done, and you are able to verify the result in your storage.
OK
Unauthorized
Forbidden
Not Found
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "domain": "BusinessPartner",
- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "createdBy": "76248934691294444",
- "createdAt": "2024-11-12T20:37:13Z",
- "modifiedAt": "2024-11-12T20:37:13Z",
- "progress": "77",
- "status": "RUNNING",
- "statusMessage": "DataSource [5e2874fb8d2a7400011acee1] has no DataMapperDefinition attached and no alternative dataMapperDefinitionId was passed to the job",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "dataSourceId": "648824a691d8d2503d65103e",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "featuresOn": [
- "UPSERT_CHANGES_ONLY"
], - "result": {
- "statistics": {
- "numberOfRecords": "500",
- "numberOfFailed": "10"
}
}
}
Starting a Transformation Job. In case any selected data source does not have a dataMappingDefinition
an API error returned.
cmd
OK
The sent request is malformed.
Unauthorized
Forbidden
{- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "dataSourceId": "648824a691d8d2503d65103e",
- "countries": [
- {
- "shortName": "CH"
}
], - "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "startAfter": "NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm",
- "featuresOn": [
- "UPSERT_CHANGES_ONLY"
]
}
{- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "domain": "BusinessPartner",
- "name": "Process vendor data.",
- "description": "I started this job to improve quality of our data.",
- "createdBy": "76248934691294444",
- "createdAt": "2024-11-12T20:37:13Z",
- "modifiedAt": "2024-11-12T20:37:13Z",
- "progress": "77",
- "status": "RUNNING",
- "statusMessage": "DataSource [5e2874fb8d2a7400011acee1] has no DataMapperDefinition attached and no alternative dataMapperDefinitionId was passed to the job",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "dataSourceId": "648824a691d8d2503d65103e",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "featuresOn": [
- "UPSERT_CHANGES_ONLY"
], - "result": {
- "statistics": {
- "numberOfRecords": "500",
- "numberOfFailed": "10"
}
}
}
Transform a list of records into Business Partner objects.
Records
OK
Unauthorized
Forbidden
Not Found
{- "recordsAsJsonString": [
- "{\"address\": \"Musterstrasse 1, 12345 Musterstadt\"}"
]
}
[- {
- "id": "63e635235c06b7396330fe40",
- "disclosed": "false",
- "names": [
- {
- "details": "Marketing department",
- "language": "DE",
- "shortname": "CDQ AG",
- "type": "LOCAL",
- "value": "Corporate Data Quality AG"
}
], - "legalForm": "Aktiengesellschaft",
- "identifiers": [
- {
- "type": "CH_VAT_ID",
- "value": "CHE-218.608.886 HR/MWST"
}
], - "categories": [
- "HOTEL"
], - "classifications": [
- {
- "code": "20.20Z",
- "label": "NAF 2003",
- "type": "NAF 2003"
}
], - "companyStatus": "ACTIVE",
- "status": {
- "explanations": [
- "No errors have been found"
], - "recordStatus": "ACCEPTED"
}, - "results": {
- "businessPartnerCurationResult": {
- "curatedBusinessPartner": { }
}, - "categorizationResult": {
- "categories": [
- {
- "categorized": "true",
- "key": "CDQ.BP.INDUSTRY",
- "label": "Industry",
- "score": "0.8"
}
]
}, - "validationResult": {
- "dataDefects": [
- {
- "attributes": [
- "Deprecated"
], - "businessRule": "Deprecated",
- "entity": "Deprecated",
- "errorCode": "0",
- "fixProposal": "Deprecated",
- "fixProposalJson": "Deprecated",
- "violationLevel": "NO_DEFECT",
- "violationMessage": "Business partner misses an optional D-U-N-S number."
}
], - "fixProposals": [
- {
- "addresses": [
- {
- "id": null,
- "externalId": null,
- "addressTypes": [ ],
- "careOf": null,
- "context": [ ],
- "country": null,
- "administrativeArea": null,
- "postCode": null,
- "locality": null,
- "thoroughfare": null,
- "premise": null,
- "postalDeliveryPoint": null,
- "geographicCoordinates": null,
- "formattedAddress": null,
- "results": null
}
], - "identifiers": [
- {
- "type": null,
- "value": null
}
], - "names": [
- {
- "details": null,
- "language": null,
- "shortname": null,
- "type": null,
- "value": null
}
]
}
]
}
}, - "addresses": [
- {
- "id": "0",
- "externalId": "1",
- "addressTypes": [
- "LEGAL_ADDRESS"
], - "careOf": "CDQ GmbH c/o Product Department",
- "context": [
- "Production hall 7, Storage field 8."
], - "country": {
- "shortname": "CH",
- "value": "Switzerland"
}, - "administrativeArea": {
- "value": "Sankt Gallen"
}, - "postCode": {
- "value": "9000",
- "type": "REGULAR"
}, - "locality": {
- "value": "Sankt Gallen",
- "type": "CITY"
}, - "thoroughfare": {
- "number": "4",
- "type": "INDUSTRIAL_ZONE",
- "value": "Lukasstraße 4"
}, - "premise": {
- "number": "4",
- "shortname": "Lukasstr. 4",
- "technicalKey": "FACTORY",
- "type": "FACTORY",
- "value": "Lukasstraße 4"
}, - "postalDeliveryPoint": {
- "number": "460",
- "type": "MAILBOX",
- "value": "Postfach"
}, - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "formattedAddress": {
- "country": "Switzerland",
- "administrativeArea": "Sankt Gallen",
- "region": "Sankt Gallen",
- "regionCode": "9004",
- "district": "City center",
- "locality": "Sankt Gallen",
- "postCode": "9000",
- "thoroughfare": "Lukassstrasse",
- "premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
- "mailStation": "US, Pasadena, MAIL STATION 201-6",
- "mailbox": "Postfach 460",
- "interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
- "postOfficeBox": "Postfach 460"
}, - "results": {
- "curationResult": {
- "accuracyIndicator": "5",
- "changes": [
- "Deprecated"
], - "curatedAddress": { },
- "curationLevel": "LEVEL_4",
- "requestSimilarity": {
- "geoCoordinates": "true",
- "locality": "1.0",
- "overall": "1.0",
- "postCode": "1.0",
- "thoroughfare": "1.0"
}, - "response": {
- "message": "Deprecated",
- "status": "OK",
- "timestamp": "2024-11-12T20:37:13Z"
}
}, - "goldenRecordGenerationResult": {
- "explanations": [
- "No errors have been found"
], - "goldenRecord": { },
- "originalBusinessPartner": { },
- "originalDataDefects": [
- {
- "attributes": [ ],
- "businessRule": null,
- "entity": null,
- "errorCode": null,
- "fixProposal": null,
- "fixProposalJson": null,
- "violationLevel": null,
- "violationMessage": null
}
], - "referenceBusinesspartners": [
- {
- "businessPartner": null,
- "matchScore": null,
- "matchingExplanation": null,
- "matchingSource": null,
- "subscribed": null
}
], - "remainingDataDefects": [
- {
- "attributes": [ ],
- "businessRule": null,
- "entity": null,
- "errorCode": null,
- "fixProposal": null,
- "fixProposalJson": null,
- "violationLevel": null,
- "violationMessage": null
}
]
}, - "lookupResults": {
- "lookupMatches": [
- {
- "address": null,
- "alei": null,
- "businessPartner": null,
- "cdqId": null,
- "inactive": null,
- "matchingExplanation": null,
- "matchingScore": null,
- "businessPartnerMatchingScore": null,
- "addressMatchingScore": null,
- "responseMetadata": null,
- "source": null
}
]
}, - "validationResult": {
- "dataDefects": [
- {
- "attributes": [ ],
- "businessRule": null,
- "entity": null,
- "errorCode": null,
- "fixProposal": null,
- "fixProposalJson": null,
- "violationLevel": null,
- "violationMessage": null
}
], - "fixProposals": [
- {
- "addresses": [ ],
- "identifiers": [ ],
- "names": [ ]
}
]
}
}
}
], - "externalId": "The ID managed in the customer's SAP systems.",
- "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
- "record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}"
}
]