Set Cleanse Functions Configuration
Learn how to configure cleanse functions.
Use this operation to configure cleanse functions.
Note: This operation overrides the cleanse section in your tenant's physical
configuration.
Request:
PUT {{applicationURL}}/tenants/{{tenantID}}/cleanse Example:
PUT https://dev.reltio.com/reltio/tenants/hX777YXpWGBFUlh/cleanse | Name | Required | Description | |
|---|---|---|---|
| Headers | Content-Type
| Yes |
Content-Type: application/json |
Authorization | Yes | ||
| Body | Yes | JSON object with Cleanse Functions specification. | |
Response
If the Cleanse Functions specification is applied successfully, then the response contains JSON with the following specification.
Example Request
PUT {{applicationURL}}/tenants/{{tenantID}}/cleanse
Body:
[
{
"cleanseFunction": "Loqate",
"options": {
"returnUnverifiedStatus": "true",
"loqateDefaultCountry": "USA",
"loqateLicensedCountry": "US;United States;USA;Canada;CA;Australia;AU"
}
},
{
"cleanseFunction": "VerificationStatusCleanser",
"type": "S3File",
"options": {
"bucket": "cleanse-files",
"path": "Sample/test.txt"
}
},
{
"cleanseFunction": "HttpStatusCleanser",
"type": "Http",
"options": {
"url": "",
"method": "GET",
"lqtkey": "EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE",
"p": "v+g",
"opts": "DefaultCountry=RUS"
}
},
{
"cleanseFunction": "UppercaseCleanser",
"type": "com.reltio.cleanse.sample.UppercaseCleanser",
"module": "cleanse-files/Sample/UppercaseCleanserEx.jar"
},
{
"cleanseFunction": "MECleanser",
"type": "com.reltio.cleanse.sample.MECleanser",
"module": "cleanse-files/Sample/UppercaseCleanserEx.jar"
},
{
"cleanseFunction": "NPICleanser",
"type": "com.reltio.cleanse.sample.NPICleanser",
"module": "cleanse-files/Sample/UppercaseCleanserEx.jar"
}
]| cleanseFunction | Description |
|---|---|
Loqate | |
VerificationStatusCleanser | |
HttpStatusCleanser | Simple HTTP cleanser. For more details, see topic HTTP Cleanse Function. Note: You cannot or post or send any security headers through HttpStatusCleanser function. |
UppercaseCleanser | |
MECleanser | |
NPICleanser |
Example Response
[
{
"cleanseFunction": "Loqate",
"options": {
"returnUnverifiedStatus": "true",
"loqateDefaultCountry": "USA",
"loqateLicensedCountry": "US;United States;USA;Canada;CA;Australia;AU"
}
},
{
"cleanseFunction": "VerificationStatusCleanser",
"type": "S3File",
"options": {
"bucket": "cleanse-files",
"path": "Sample/test.txt"
}
},
{
"cleanseFunction": "HttpStatusCleanser",
"type": "Http",
"options": {
"url": "",
"method": "GET",
"lqtkey": "EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE",
"p": "v+g",
"opts": "DefaultCountry=RUS"
}
},
{
"cleanseFunction": "UppercaseCleanser",
"type": "com.reltio.cleanse.sample.UppercaseCleanser",
"module": "cleanse-files/Sample/UppercaseCleanserEx.jar"
},
{
"cleanseFunction": "MECleanser",
"type": "com.reltio.cleanse.sample.MECleanser",
"module": "cleanse-files/Sample/UppercaseCleanserEx.jar"
},
{
"cleanseFunction": "NPICleanser",
"type": "com.reltio.cleanse.sample.NPICleanser",
"module": "cleanse-files/Sample/UppercaseCleanserEx.jar"
}
]