Update transform instance settings

Enables Loqate transform module and settings. Loqate transforms are run as part of DW jobs (before DW prescripts are run).

Request Method Service URL
PUT /api-metadata/v1/{access-key}/metadata/transforminstances/DWLoqateValidator
Request Headers

Content-Type=application/json

Request Body Parameters

Parameter Data Type Description
active Boolean

Whether or not Loqate Address validation is enabled or disabled. Defaults to false, meaning feature is disabled. To use Loqate Address validation, this flag needs to be set to true. When enabled, it will start validating new incoming records.

Nested schema: parameters

Parameter Data Type Description
validationFlags string

Controls if the request should perform address verification or address verification and also GeoCodes. Possible values include Verify and Verify,Geocode.

Defaults to Verify, which means the request will only perform address verification. If you want to get GeoCodes in addition to default verification, then, validation flag will be set as "validationFlags": "Verify,Geocode".
outputColumnMapping string

Determines how to map Loqate output to Oracle Unity schema. Explanation of the available attributes and their values can be found here. This is the default mapping (part of base tenant metadata). Key is is Loqate output field, value is Oracle Unity schema attribute. For example:

  • "Address1:addressline1"

When Geocode is enabled, field mapping is as follows, in addition to above default mapping:

  • "Latitude:latitude"

  • "Longitude:longitude"

inputColumnMapping string

Determines what attribute to pass into Loqate. Default input mapping (part of base tenant metadata) is (left hand side is Unity schema attribute, right hand side is Loqate input field). For example:

  • "Address.addressline1:Address1"

Example

Update transform instance settings for Loqate Validator.

Request URL

http://{AccountURL}/api-metadata/v1/e2a7a0df2410470d85ef69c8dad2bdb8/metadata/transforminstances/DWLoqateValidator

Request Body

{
  "tenantId": 1,
  "name": "DWLoqateValidator",
  "description": "DW transform",
  "active": true,
  "componentDefinitionId": "LoqateValidator",
  "uniqueInstanceId": "DWLoqateValidator",
  "parameters": {
    "validationFlags": "Verify",
    "outputColumnMapping": "Address1:addressline1,Address2:addressline2,ISO3166-2:countrycode_isoalpha2,ISO3166-3:countrycode_isoalpha3,Locality:city,AdministrativeArea:state,SubAdministrativeArea:county,PostalCode:zipcode,SubBuildingNumber:apartmentno",
    "entities": "address",
    "inputColumnMapping": "addressline1:Address1,addressline2:Address2,zipcode:PostalCode,country:Country,apartmentno:SubBuildingNumber,city:Locality,state:AdministrativeArea,county:SubAdministrativeArea",
    "referenceName": "loqatedwmapping"
  }
}

Response

The response returns a list of Loqate transform settings.

Learn more

Address Validation