On-the-fly Entity Batch Cleanse API
This API cleanses the entity data in the tenant on-the-fly, using batches.
Once the cleansing is done, this API returns a body of the cleansed entities that is not persisted into the database.
Request
POST {{api_uri}}/{{tenant}}/entities/batchcleanse?type=other&returnUserData=true| Parameter | Required | Description |
|---|---|---|
tenantId
|
Yes | This is the ID of the tenant to re-cleanse the entity information. |
type
|
Yes | This indicates the cleanser name or the cleanser type URI to be used for cleansing. |
returnUserData
|
No | This parameter is false by default and returns the output,
that is the cleansed data. If set to true, it returns both the
input data (information passed in the body) and the output data (cleansed
data). |
Request Body
The request body consists of an array of Objects. This API cleanses the batch of entities and returns the cleansed data without persisting it to the database. The response consists of entities in the same order as they appear in the request.
Sample Request Body
[
{
"type": "configuration/entityTypes/SalesAssoc",
"attributes": {
"FirstName": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/FirstName",
"value": "Hollger"
}
],
"LastName": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/LastName",
"value": "keisik"
}
],
"Gender": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Gender",
"value": "M"
}
],
"Addresses": [
{
"value": [
{
"AddressLine1": [
{
"value": "6500 Excelsior Boulevard"
}
],
"StateProvince": [
{
"value": "MN"
}
],
"City": [
{
"value": "Saint Louis Park"
}
],
"Country": [
{
"value": "United States"
}
],
"Zip": [
{
"value": {
"Zip5": {
"value": "55426"
}
}
}
]
}
]
}
],
"Email": [
{
"value": {
"Type": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Email/attributes/Type",
"value": "Private"
}
],
"Email": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Email/attributes/Email",
"value": "jirae@hotmail.com"
}
],
"EmailStatus": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Email/attributes/EmailStatus",
"value": "Active"
}
]
}
}
],
"Phone": [
{
"value": {
"Type": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Phone/attributes/Type",
"value": "Home"
}
],
"Number": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Phone/attributes/Number",
"value": "4255149756"
}
],
"PhoneStatus": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Phone/attributes/PhoneStatus",
"value": "Active"
}
]
}
}
],
"DoB": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/DoB",
"value": "16/06/1978"
}
]
},
"crosswalks": [
{
"type": "configuration/sources/POS",
"value": "0006525449144",
"sourceTable": "client"
}
]
},
{
"type": "configuration/entityTypes/SalesAssoc",
"attributes": {
"FirstName": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/FirstName",
"value": "Harry"
}
],
"LastName": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/LastName",
"value": "William"
}
],
"Gender": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Gender",
"value": "M"
}
],
"Addresses": [
{
"value": [
{
"AddressLine1": [
{
"value": "8110 Gatehouse Road Suite 200, East Tower"
}
],
"StateProvince": [
{
"value": "VA"
}
],
"City": [
{
"value": "Falls Church"
}
],
"Country": [
{
"value": "United States"
}
],
"Zip": [
{
"value": {
"Zip5": {
"value": "22042"
}
}
}
]
}
]
}
],
"Email": [
{
"value": {
"Type": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Email/attributes/Type",
"value": "Official"
}
],
"Email": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Email/attributes/Email",
"value": "mira@hotmail.com"
}
],
"EmailStatus": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Email/attributes/EmailStatus",
"value": "Active"
}
]
}
}
],
"Phone": [
{
"value": {
"Type": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Phone/attributes/Type",
"value": "Office"
}
],
"Number": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Phone/attributes/Number",
"value": "42551423234"
}
],
"PhoneStatus": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Phone/attributes/PhoneStatus",
"value": "Active"
}
]
}
}
],
"DoB": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/DoB",
"value": "10/12/1978"
}
]
},
"crosswalks": [
{
"type": "configuration/sources/POS",
"value": "0006525449144",
"sourceTable": "client"
}
]
},
{
"type": "configuration/entityTypes/SalesAssoc",
"attributes": {
"FirstName": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/FirstName",
"value": "Jhon"
}
],
"LastName": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/LastName",
"value": "Kevsaki"
}
],
"Gender": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Gender",
"value": "M"
}
],
"Addresses": [
{
"value": [
{
"AddressLine1": [
{
"value": "6500 Excelsior Boulevard"
}
],
"StateProvince": [
{
"value": "MN"
}
],
"City": [
{
"value": "Saint Louis Park"
}
],
"Country": [
{
"value": "United States"
}
],
"Zip": [
{
"value": {
"Zip5": {
"value": "55426"
}
}
}
]
}
]
}
],
"Email": [
{
"value": {
"Type": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Email/attributes/Type",
"value": "Private"
}
],
"Email": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Email/attributes/Email",
"value": "kira@hotmail.com"
}
],
"EmailStatus": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Email/attributes/EmailStatus",
"value": "Active"
}
]
}
}
],
"Phone": [
{
"value": {
"Type": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Phone/attributes/Type",
"value": "Home"
}
],
"Number": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Phone/attributes/Number",
"value": "42551412334"
}
],
"PhoneStatus": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/Phone/attributes/PhoneStatus",
"value": "Active"
}
]
}
}
],
"DoB": [
{
"type": "configuration/entityTypes/SalesAssoc/attributes/DoB",
"value": "15/12/1976"
}
]
},
"crosswalks": [
{
"type": "configuration/sources/POS",
"value": "0006525449144",
"sourceTable": "client"
}
]
}
]