Accelerate the Value of Data

Set Cleanse Functions Configuration

You can configure Cleanse functions using this API.

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 
Table 1. Parameters
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"
    }
]
Table 2. cleanseFunction details
cleanseFunction Description
Loqate
VerificationStatusCleanser
HttpStatusCleanserSimple HTTP cleanser where you can post JASON payload and receive response.
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"
    }
]