Configuration

Used to create, read, update, and delete the configurations which define the settings for the augmentation process of Business Partners.

Create augmentation configuration

Endpoint to create a new augmentation configuration.

SecurityapiKey

Request

Request Body schema: application/json

object (AugmentationConfiguration)

The effective settings for the augmentation.

featuresOn

Array of strings (TransactionFeaturesOn)

Features to be enabled. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum:	Description
CREATE_TRANSACTION	Creates a new transaction and makes the current request a part of it. By default turned off.
COMMIT_TRANSACTION	Commit transaction. By default turned off.

Example: ["CREATE_TRANSACTION"]

name

string (ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

Array of objects (RelatedConfigurations) <= 10 items

List of related configurations.

transactionId

string (TransactionId)

Id of the transaction, pass it in subsequent requests to make them part of the transaction

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

workspaceId

string (WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

Responses

200

Augmentation configuration created successfully

400

Bad Request.

post/configurations/augmentation

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"configuration": {"lookupConfiguration": {"outputSettings": {"maxCandidates": 50,
"limit": 20,
"matchingThreshold": 0.5
}
},
"curationConfiguration": {"curationSettings": [{"outputSettings": {"outputCharsets": [{"concept": "ADDRESS",
"charset": "UTF8"
}
],
"outputLanguage": {"technicalKey": ""
}
},
"addressCurationSettings": {"ignoreAddressConcepts": [ ],
"curationLevelThreshold": "",
"numberSeparator": { }
},
"featureSettings": {"featuresOn": [ ],
"featuresOff": [ ],
"profile": "FEATURES_OFF"
},
"countryScope": {"shortName": "WORLD"
}
}
]
},
"referenceDataSourceUsages": [{"referenceDataSource": {"technicalKey": "VIES"
},
"updates": {"enabled": true
}
},
{"referenceDataSource": {"technicalKey": "CH_UIDR"
},
"updates": {"enabled": true
}
}
]
},
"name": "Client configuration"
}

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"createdAt": "2024-10-16T09:22:40Z",
"createdBy": "76248934691294444",
"modifiedAt": "2024-10-16T09:22:40Z",
"configuration": {"lookupConfiguration": {"featureSettings": {"featuresOn": ["CURATE_REQUEST"
],
"featuresOff": ["CURATE_REQUEST"
]
},
"outputSettings": {"matchingThreshold": 0.75,
"maxCandidates": 50,
"limit": 100
}
},
"curationConfiguration": {"curationSettings": [{"countryScope": {"shortName": "CH"
},
"featureSettings": {"profile": "STANDARD",
"featuresOn": ["ENRICH_IDENTIFIERS"
],
"featuresOff": ["ENRICH_IDENTIFIERS"
]
},
"addressCurationSettings": {"curationLevelThreshold": "0.75",
"dataSourcePriority": {"primaryAddressDataSource": {"technicalKey": null,
"threshold": null
},
"secondaryAddressDataSources": [null
]
},
"numberSeparator": {"value": ","
},
"ignoreAddressConcepts": [{"technicalKey": null
}
],
"inputAddressConceptsIgnored": [{"technicalKey": null
}
]
},
"outputSettings": {"outputLanguage": {"technicalKey": "en"
},
"outputCharsets": [{"concept": null,
"charset": null
}
]
}
}
],
"goldenRecordSettings": {"dataSources": [{"countryScope": {"shortName": "CH"
},
"primaryDataSource": {"technicalKey": "BR_RF"
},
"secondaryDataSources": [{"technicalKey": null
}
],
"otherDataSources": [{"technicalKey": null
}
],
"unallowedDataSources": [{"technicalKey": null
}
]
}
]
}
},
"referenceDataSourceUsages": [{"referenceDataSource": {"technicalKey": "BR_RF"
},
"lookup": true,
"updates": {"enabled": true
}
}
],
"storageDataSourceUsages": [{"storageDataSource": {"id": "648824a691d8d2503d65103e"
},
"lookup": true,
"updates": {"enabled": true,
"linkageStrategy": {"externalContext": {"identifiers": [null
]
}
}
}
}
]
},
"relatedConfigurations": [{"id": "a0200062daa56952a8640005",
"owner": {"service": "reference-data-api",
"path": "/public/configurations/businesspartnerlookup"
}
}
],
"transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Delete augmentation configuration

Endpoint to delete an existing augmentation configuration.

SecurityapiKey

Request

path Parameters

configurationId

required

string (ConfigurationId)

Filter by specified Configuration ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

200

OK.

400

Bad Request.

delete/configurations/augmentation/{configurationId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"createdAt": "2024-10-16T09:22:40Z",
"createdBy": "76248934691294444",
"modifiedAt": "2024-10-16T09:22:40Z",
"configuration": {"lookupConfiguration": {"featureSettings": {"featuresOn": ["CURATE_REQUEST"
],
"featuresOff": ["CURATE_REQUEST"
]
},
"outputSettings": {"matchingThreshold": 0.75,
"maxCandidates": 50,
"limit": 100
}
},
"curationConfiguration": {"curationSettings": [{"countryScope": {"shortName": "CH"
},
"featureSettings": {"profile": "STANDARD",
"featuresOn": ["ENRICH_IDENTIFIERS"
],
"featuresOff": ["ENRICH_IDENTIFIERS"
]
},
"addressCurationSettings": {"curationLevelThreshold": "0.75",
"dataSourcePriority": {"primaryAddressDataSource": {"technicalKey": null,
"threshold": null
},
"secondaryAddressDataSources": [null
]
},
"numberSeparator": {"value": ","
},
"ignoreAddressConcepts": [{"technicalKey": null
}
],
"inputAddressConceptsIgnored": [{"technicalKey": null
}
]
},
"outputSettings": {"outputLanguage": {"technicalKey": "en"
},
"outputCharsets": [{"concept": null,
"charset": null
}
]
}
}
],
"goldenRecordSettings": {"dataSources": [{"countryScope": {"shortName": "CH"
},
"primaryDataSource": {"technicalKey": "BR_RF"
},
"secondaryDataSources": [{"technicalKey": null
}
],
"otherDataSources": [{"technicalKey": null
}
],
"unallowedDataSources": [{"technicalKey": null
}
]
}
]
}
},
"referenceDataSourceUsages": [{"referenceDataSource": {"technicalKey": "BR_RF"
},
"lookup": true,
"updates": {"enabled": true
}
}
],
"storageDataSourceUsages": [{"storageDataSource": {"id": "648824a691d8d2503d65103e"
},
"lookup": true,
"updates": {"enabled": true,
"linkageStrategy": {"externalContext": {"identifiers": [null
]
}
}
}
}
]
},
"relatedConfigurations": [{"id": "a0200062daa56952a8640005",
"owner": {"service": "reference-data-api",
"path": "/public/configurations/businesspartnerlookup"
}
}
],
"transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

List configurations

Read augmentation configurations of this workspace.

SecurityapiKey

Request

query Parameters

defaultConfiguration	boolean Is default workspace configuration of given type. Example: defaultConfiguration=true
limit	integer (Limit) Size of the page. Example: limit=100
startAfter	string (StartAfter) Pagination parameter for determining next page. Example: startAfter=5712566172571652

Responses

200

Successful operation

get/configurations/augmentation

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"total": "67",
"values": [{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"createdAt": "2024-10-16T09:22:40Z",
"createdBy": "76248934691294444",
"modifiedAt": "2024-10-16T09:22:40Z"
}
]
}

Read configuration

Endpoint to retrieve an augmentation configuration based on its ID.

SecurityapiKey

Request

path Parameters

configurationId

required

string (ConfigurationId)

Filter by specified Configuration ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

200

Successful operation

get/configurations/augmentation/{configurationId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"createdAt": "2024-10-16T09:22:40Z",
"createdBy": "76248934691294444",
"modifiedAt": "2024-10-16T09:22:40Z",
"configuration": {"lookupConfiguration": {"featureSettings": {"featuresOn": ["CURATE_REQUEST"
],
"featuresOff": ["CURATE_REQUEST"
]
},
"outputSettings": {"matchingThreshold": 0.75,
"maxCandidates": 50,
"limit": 100
}
},
"curationConfiguration": {"curationSettings": [{"countryScope": {"shortName": "CH"
},
"featureSettings": {"profile": "STANDARD",
"featuresOn": ["ENRICH_IDENTIFIERS"
],
"featuresOff": ["ENRICH_IDENTIFIERS"
]
},
"addressCurationSettings": {"curationLevelThreshold": "0.75",
"dataSourcePriority": {"primaryAddressDataSource": {"technicalKey": null,
"threshold": null
},
"secondaryAddressDataSources": [null
]
},
"numberSeparator": {"value": ","
},
"ignoreAddressConcepts": [{"technicalKey": null
}
],
"inputAddressConceptsIgnored": [{"technicalKey": null
}
]
},
"outputSettings": {"outputLanguage": {"technicalKey": "en"
},
"outputCharsets": [{"concept": null,
"charset": null
}
]
}
}
],
"goldenRecordSettings": {"dataSources": [{"countryScope": {"shortName": "CH"
},
"primaryDataSource": {"technicalKey": "BR_RF"
},
"secondaryDataSources": [{"technicalKey": null
}
],
"otherDataSources": [{"technicalKey": null
}
],
"unallowedDataSources": [{"technicalKey": null
}
]
}
]
}
},
"referenceDataSourceUsages": [{"referenceDataSource": {"technicalKey": "BR_RF"
},
"lookup": true,
"updates": {"enabled": true
}
}
],
"storageDataSourceUsages": [{"storageDataSource": {"id": "648824a691d8d2503d65103e"
},
"lookup": true,
"updates": {"enabled": true,
"linkageStrategy": {"externalContext": {"identifiers": [null
]
}
}
}
}
]
},
"relatedConfigurations": [{"id": "a0200062daa56952a8640005",
"owner": {"service": "reference-data-api",
"path": "/public/configurations/businesspartnerlookup"
}
}
],
"transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Update existing augmentation configuration

Endpoint to update an existing augmentation configuration.

SecurityapiKey

Request

path Parameters

configurationId

required

string (ConfigurationId)

Filter by specified Configuration ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Request Body schema: application/json

object (AugmentationConfiguration)

The effective settings for the augmentation.

featuresOn

Array of strings (AugmentationConfigurationUpdateFeaturesOn)

Features to be activated.

Items Value:	Description
REEVALUATION_ON_CHANGES	Re-evaluates business partners based on changes in the configuration.

Example: ["REEVALUATION_ON_CHANGES"]

name

string (ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

transactionId

string (TransactionId)

Id of the transaction, pass it in subsequent requests to make them part of the transaction

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

Responses

200

Augmentation configuration updated successfully

400

Bad Request.

put/configurations/augmentation/{configurationId}

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
"featuresOn": ["REEVALUATION_ON_CHANGES"
],
"name": "Client configuration.",
"configuration": {"lookupConfiguration": {"featureSettings": {"featuresOn": ["CURATE_REQUEST"
],
"featuresOff": ["CURATE_REQUEST"
]
},
"outputSettings": {"matchingThreshold": 0.75,
"maxCandidates": 50,
"limit": 100
}
},
"curationConfiguration": {"curationSettings": [{"countryScope": {"shortName": "CH"
},
"featureSettings": {"profile": "STANDARD",
"featuresOn": ["ENRICH_IDENTIFIERS"
],
"featuresOff": ["ENRICH_IDENTIFIERS"
]
},
"addressCurationSettings": {"curationLevelThreshold": "0.75",
"dataSourcePriority": {"primaryAddressDataSource": {"technicalKey": null,
"threshold": null
},
"secondaryAddressDataSources": [null
]
},
"numberSeparator": {"value": ","
},
"ignoreAddressConcepts": [{"technicalKey": null
}
],
"inputAddressConceptsIgnored": [{"technicalKey": null
}
]
},
"outputSettings": {"outputLanguage": {"technicalKey": "en"
},
"outputCharsets": [{"concept": null,
"charset": null
}
]
}
}
],
"goldenRecordSettings": {"dataSources": [{"countryScope": {"shortName": "CH"
},
"primaryDataSource": {"technicalKey": "BR_RF"
},
"secondaryDataSources": [{"technicalKey": null
}
],
"otherDataSources": [{"technicalKey": null
}
],
"unallowedDataSources": [{"technicalKey": null
}
]
}
]
}
},
"referenceDataSourceUsages": [{"referenceDataSource": {"technicalKey": "BR_RF"
},
"lookup": true,
"updates": {"enabled": true
}
}
],
"storageDataSourceUsages": [{"storageDataSource": {"id": "648824a691d8d2503d65103e"
},
"lookup": true,
"updates": {"enabled": true,
"linkageStrategy": {"externalContext": {"identifiers": [null
]
}
}
}
}
]
}
}

Response samples

application/json

{"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"name": "Client configuration.",
"createdAt": "2024-10-16T09:22:40Z",
"createdBy": "76248934691294444",
"modifiedAt": "2024-10-16T09:22:40Z",
"configuration": {"lookupConfiguration": {"featureSettings": {"featuresOn": ["CURATE_REQUEST"
],
"featuresOff": ["CURATE_REQUEST"
]
},
"outputSettings": {"matchingThreshold": 0.75,
"maxCandidates": 50,
"limit": 100
}
},
"curationConfiguration": {"curationSettings": [{"countryScope": {"shortName": "CH"
},
"featureSettings": {"profile": "STANDARD",
"featuresOn": ["ENRICH_IDENTIFIERS"
],
"featuresOff": ["ENRICH_IDENTIFIERS"
]
},
"addressCurationSettings": {"curationLevelThreshold": "0.75",
"dataSourcePriority": {"primaryAddressDataSource": {"technicalKey": null,
"threshold": null
},
"secondaryAddressDataSources": [null
]
},
"numberSeparator": {"value": ","
},
"ignoreAddressConcepts": [{"technicalKey": null
}
],
"inputAddressConceptsIgnored": [{"technicalKey": null
}
]
},
"outputSettings": {"outputLanguage": {"technicalKey": "en"
},
"outputCharsets": [{"concept": null,
"charset": null
}
]
}
}
],
"goldenRecordSettings": {"dataSources": [{"countryScope": {"shortName": "CH"
},
"primaryDataSource": {"technicalKey": "BR_RF"
},
"secondaryDataSources": [{"technicalKey": null
}
],
"otherDataSources": [{"technicalKey": null
}
],
"unallowedDataSources": [{"technicalKey": null
}
]
}
]
}
},
"referenceDataSourceUsages": [{"referenceDataSource": {"technicalKey": "BR_RF"
},
"lookup": true,
"updates": {"enabled": true
}
}
],
"storageDataSourceUsages": [{"storageDataSource": {"id": "648824a691d8d2503d65103e"
},
"lookup": true,
"updates": {"enabled": true,
"linkageStrategy": {"externalContext": {"identifiers": [null
]
}
}
}
}
]
},
"relatedConfigurations": [{"id": "a0200062daa56952a8640005",
"owner": {"service": "reference-data-api",
"path": "/public/configurations/businesspartnerlookup"
}
}
],
"transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}