Decision Log

Provides services for managing decisions for Business Partners. Decisions are stored in a Decision Log and can be retrieved, upserted, cleared or deleted.

Clear Decisions

Deletes decisions of a given type. Deletes all if type not provided.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

	Array of objects (DecisionClearDataSourceParam) List of Data Source IDs to be cleared.
	object (DecisionLogType) Type of decision log entry.

Responses

200

400

Bad Request

post/storages/{storageId}/decisions/clear

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"type": {"technicalKey": "CURATIONS"
},
"dataSources": [{"id": "648824a691d8d2503d65103e"
}
]
}

Response samples

application/json

{"numberOfDeleted": "10"
}

Delete Decisions

Deletes decisions of a given ids.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

required

Array of objects (DecisionDelete) non-empty

List of decisions to be deleted.

Responses

200

400

Bad Request

post/storages/{storageId}/decisions/delete

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"decisions": [{"id": "63e635235c06b7396330fe40",
"businessPartnerId": "63e635235c06b7396330fe40"
}
]
}

Response samples

application/json

{"numberOfDeleted": "10"
}

Poll Curation Decision Import Job

Poll curation decision import job.

SecurityapiKey

Request

path Parameters

jobId

required

string (JobId)

Unique identifier of a job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de

Responses

200

400

Bad Request

get/jobs/curationdecisionimportjobs/{jobId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"name": "Process vendor data.",
"description": "I started this job to improve quality of our data.",
"status": "RUNNING",
"statusMessage": "The job failed because storage is empty.",
"createdAt": "2024-09-06T20:43:34Z",
"user": "742429-234242-4343-232323",
"progress": "The job failed because storage is empty.",
"attachments": [{"url": "customer-upload/user/file.xlsx",
"tags": ["Reporting"
]
}
]
}

Read Decisions

Read decisions from given storage.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

query Parameters

businessPartnerIds

Array of strings (DecisionLogBusinessPartnerId) <= 500 items

Only show decisions for listed business partner IDs.

Example: businessPartnerIds=63e635235c06b7396330fe40

limit

integer <int32> >= 1

Default: 500

Number of items to be returned on the page.

Example: limit=100

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

type

string (DecisionLogTypeTechnicalKeyParam)

Only show decisions of given type.

Enum:	Description
CURATIONS	Curation decisions.
NATURAL_PERSONS	Natural person decisions.
DUPLICATES	Duplicate decisions.

Example: type=CURATIONS

Responses

200

400

Bad Request

get/storages/{storageId}/decisions

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"values": [{"id": "63e635235c06b7396330fe40",
"type": {"technicalKey": "CURATIONS"
},
"businessPartnerId": "63e635235c06b7396330fe40",
"dataSourceId": "648824a691d8d2503d65103e",
"externalId": "The ID managed in the customer's SAP systems.",
"lastUpdatedAt": "2024-09-06T20:43:34Z",
"lastUpdatedBy": "username",
"updateDecisions": [{"context": {"createdBy": "76248934691294444",
"createdAt": "2024-09-06T20:43:34Z",
"scope": {"dataSourceIds": [null
],
"countryShortNames": [null
],
"curationSimilarity": "0.8"
}
},
"proposal": {"externalIds": [{"externalId": null,
"dataSourceId": null,
"id": null,
"concept": null,
"language": null,
"characterSet": null,
"type": null
}
],
"property": {"parentConcept": {"name": null,
"technicalKey": null
},
"name": "Minority Indicator Value",
"technicalKey": "MINORITY_INDICATOR_VALUE",
"contentSelector": "$.partnerProfile.minorityIndicator.value",
"instanceSelectors": [null
]
},
"newContent": "AAB",
"previousContent": "AAB",
"provenance": {"name": "VIES",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429",
"subscribers": "7",
"subscribed": "true",
"lastUpdatedAt": "20230111",
"lastSyncAt": "20230113"
},
"changeType": "MODIFIED",
"changeClassification": "MAJOR",
"confidenceScore": "0.0",
"maxConfidenceScore": "1.0",
"matchingScores": {"overall": "0.9",
"businessPartner": "0.9",
"address": "0.9"
}
},
"status": "ACCEPTED",
"reliability": "TRUSTED_SOURCE"
}
],
"validationDecisions": [{"context": {"createdBy": "76248934691294444",
"createdAt": "2024-09-06T20:43:34Z"
},
"dataDefect": {"businessRule": {"url": "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"
},
"properties": [{"parentConcept": null,
"content": null,
"url": null,
"instanceSelectors": [ ]
}
]
},
"status": "ACCEPTED"
}
]
}
],
"limit": "100",
"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"total": "67"
}

Start Curation Decision Import Job

Starts curation decision import job

SecurityapiKey

Request

Request Body schema: application/json
required

dataSourceId	string (BusinessPartnerStorageDataSourceId) Unique identifier for a Data Source of the Storage. Example: "648824a691d8d2503d65103e"
onlyNotReviewed	boolean Default: false If set to true, only curation decisions that have not been reviewed yet will be imported. If set to false, all curation decisions will be imported. Example: "true"
required	object (CurationDecisionImportJobScope) Scope of a curation decision import job.
storageId required	string (BusinessPartnerStorageId) Unique identifier of the Storage. Example: "72d6900fce6b326088f5d9d91049e3e6"

Responses

200

400

Bad Request

post/jobs/curationdecisionimportjobs

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"dataSourceId": "648824a691d8d2503d65103e",
"onlyNotReviewed": "true",
"scope": {"accepted": {"identifiers": [{"technicalKey": "EU_VAT_ID_DE",
"changeTypes": ["ADDED"
],
"countryShortNames": ["CH"
],
"thresholds": {"businessPartnerRequestSimilarity": "0.8",
"addressRequestSimilarity": "0.8",
"businessPartnerMatchingScore": "0.8",
"addressMatchingScore": "0.8"
}
}
]
},
"rejected": {"identifiers": [{"technicalKey": "EU_VAT_ID_DE",
"changeTypes": ["ADDED"
],
"countryShortNames": ["CH"
],
"thresholds": {"businessPartnerRequestSimilarity": "0.8",
"addressRequestSimilarity": "0.8",
"businessPartnerMatchingScore": "0.8",
"addressMatchingScore": "0.8"
}
}
]
}
}
}

Response samples

application/json

{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"name": "Process vendor data.",
"description": "I started this job to improve quality of our data.",
"status": "RUNNING",
"statusMessage": "The job failed because storage is empty.",
"createdAt": "2024-09-06T20:43:34Z",
"user": "742429-234242-4343-232323",
"progress": "The job failed because storage is empty.",
"attachments": [{"url": "customer-upload/user/file.xlsx",
"tags": ["Reporting"
]
}
]
}

Upsert Decisions

Upsert decisions for given storage. Decisions are distinguished by business partner id and type. Already existing decision will be replaced.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

required

Array of objects (DecisionsUpsertEntry) non-empty

List of decisions to be upserted.

Responses

200

400

Bad Request

post/storages/{storageId}/decisions

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"decisions": [{"type": {"technicalKey": "CURATIONS"
},
"businessPartnerId": "63e635235c06b7396330fe40",
"dataSourceId": "648824a691d8d2503d65103e",
"externalId": "The ID managed in the customer's SAP systems.",
"updateDecisions": [{"context": {"createdBy": "76248934691294444",
"createdAt": "2024-09-06T20:43:34Z",
"scope": {"dataSourceIds": [null
],
"countryShortNames": [null
],
"curationSimilarity": "0.8"
}
},
"proposal": {"externalIds": [{"externalId": null,
"dataSourceId": null,
"id": null,
"concept": null,
"language": null,
"characterSet": null,
"type": null
}
],
"property": {"parentConcept": {"name": null,
"technicalKey": null
},
"name": "Minority Indicator Value",
"technicalKey": "MINORITY_INDICATOR_VALUE",
"contentSelector": "$.partnerProfile.minorityIndicator.value",
"instanceSelectors": [null
]
},
"newContent": "AAB",
"previousContent": "AAB",
"provenance": {"name": "VIES",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429",
"subscribers": "7",
"subscribed": "true",
"lastUpdatedAt": "20230111",
"lastSyncAt": "20230113"
},
"changeType": "MODIFIED",
"changeClassification": "MAJOR",
"confidenceScore": "0.0",
"maxConfidenceScore": "1.0",
"matchingScores": {"overall": "0.9",
"businessPartner": "0.9",
"address": "0.9"
}
},
"status": "ACCEPTED",
"reliability": "TRUSTED_SOURCE"
}
],
"validationDecisions": [{"context": {"createdBy": "76248934691294444",
"createdAt": "2024-09-06T20:43:34Z"
},
"dataDefect": {"businessRule": {"url": "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"
},
"properties": [{"parentConcept": null,
"content": null,
"url": null,
"instanceSelectors": [ ]
}
]
},
"status": "ACCEPTED"
}
]
}
]
}

Response samples

application/json

{"numberOfProvidedDecisions": "10",
"numberOfInserts": "5",
"numberOfUpdates": "5"
}

Decision Log

Clear Decisions

path Parameters

Request Body schema: application/jsonrequired

Delete Decisions

path Parameters

Request Body schema: application/jsonrequired

Poll Curation Decision Import Job

path Parameters

Read Decisions

path Parameters

query Parameters

Start Curation Decision Import Job

Request Body schema: application/jsonrequired

Upsert Decisions

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required