On a Dataverse table, you can use web service rules for these purposes:

  • Validate data: Using a web service, you can validate if a new or changed field value in a Dataverse table matches a value in another internal or external source.
  • Validate and set data: Using a web service, you can:
    1. Validate if a new or changed field value in a Dataverse table matches a value in another internal or external source.
    2. Get a field value from another internal or external source and set this value in a Dataverse table.

Before you can set up a web service rule, set up the web service to be used.

This flow explains how to set up a web service rule.


Data quality administrator Data quality administrator Start Start Desired web  API exists? Desired web  API exists? Set up web service Set up web service On a Dataverse table, you can use a web service rule to: Validate if a field value matches a value in another internal or external source. Set a field value with a value from another internal or external source. To set up a web service rule, first set up the web service to be used. You can find the required web service settings, to be used for the web service setup, in the technical documentation as provided by the web service provider. Procedure 1. Sign in to Data quality studio on Dataverse. Note: Data quality studio on Dataverse supports only these request types:Get: When the webservice is called, the parameters and parameter values are automatically added to the web service request URL.Post: When the webservice is called, the parameters and parameter values are automatically added to the web service request body. 2. In the Site Map, click Web APIs. 3. Click New. 4. In the Name field, type a value. 5. In the URL field, enter the web service URL. 6. In the Authentication Type field, select the 'Request Header' authentication type. Note: Data quality studio on Dataverse supports only authentication type 'Request Header'.If no authentication is required for the web service, enter a dummy value in the Parameter name field and Parameter value field. 7. In the Parameter Name field, enter the authentication name. 8. In the Parameter Value field, enter the secret. 9. Define the request type for the web service, as provided by the web service provider. In the Request Type field, select the desired option. Note: Data quality studio on Dataverse supports only these request types:Get: When the webservice is called, the parameters and parameter values are automatically added to the web service request URL.Post: When the webservice is called, the parameters and parameter values are automatically added to the web service request body. 10. In the Error Message field, enter the message that is shown when validation fails. 11. In the Owner field, if desired, you can make changes. 12. Subtask: Test web service. 13. In the Test Cases section, click New Web Service Test. 14. In the Input Parameter field, enter a test request body. 15. In the Expected Output field, enter the expected response. Notes Data quality studio on Dataverse supports only these request types: Get: When the webservice is called, the parameters and parameter values are  Post Set up web service validation rule Set up web service validation rule On a Dataverse table, you can use web service rules for these purposes: Validate data Validate and set data Before you can set up a web service rule, set up the web service to be used. This topic explains how to set up a web service rule. You can find the required web service settings, to be used for the web service rule, in the technical documentation as provided by the web service provider. Validate data Using a web service, you can validate if a new or changed field value in a Dataverse table matches a value in another internal or external source. Example: Use a web service rule to validate a ZIP code and house number combination. For request type 'POST', the request JSON is, for example:   {       "code":3905 NR,       "housenumber":2   }   Validate and set data Using a web service, you can: Validate if a new or changed field value in a Dataverse table matches a value in another internal or external source. Get a field value from another internal or external source and set this value in a Dataverse table. Example: Use a web service rule to first validate if a ZIP code and house number combination is valid. If valid, based on the ZIP code, set address data like street name, city name, and province name. For request type 'POST', the response JSON is, for example, when successful:   {       "response":true,       "street":Kazemat,       "city":Veenendaal,       "province":Utrecht   } Note: With a web service rule, you can only set field values in Dataverse if first a validation is successfully done. Procedure 1. Sign in to Data quality studio on Dataverse. 2. In the Site map, click Configurations. 3. Click New. 4. In the Table field, enter or select the table to which the validation rule is applied. 5. In the Column field, enter or select the desired column. 6. In the Validation Type field, select 'Web API'. 7. In the Web API field, enter or select the web service to be used. 8. In the Owner field, if desired, you can make changes. 9. Click Save. 10. Subtask: Set request parameters 11. In the Request Parameters section, click New Web API parameter. 12. In the Name field, enter the parameter name as used in the request body. 13. In the Parameter Type field, select 'Request'. 14. In the Bound field, select the desired option. 15. In the Value field, select the desired column or enter the desired fixed values. 16. Click Save & Close. 17. Subtask: Set response parameters. 18. In the Response Parameters section, click New Web API parameter. 19. In the Name field, enter the parameter name as used in the response. 20. In the Parameter Type field, select 'Response'. 21. In the Bound field, select the desired option. 22. In the Success Values field, enter the possible values. 23. In the Value field, select the desired column. 24. Click Save & Close. 25. Subtask: Set conditions. 26. Click the Conditions tab. 27. Click New condition. 28. In the Column field, enter or select the field on which the condition is based. 29. In the Equality field, select the desired option. 30. In the Value field, enter the field value on which the condition is based. 31. Click Save & Close. End End No Yes

Activities

Name Responsible Description

Set up web service

Data quality administrator

On a Dataverse table, you can use a web service rule to:

  • Validate if a field value matches a value in another internal or external source.
  • Set a field value with a value from another internal or external source.

To set up a web service rule, first set up the web service to be used.

You can find the required web service settings, to be used for the web service setup, in the technical documentation as provided by the web service provider.

Set up web service validation rule

Data quality administrator

On a Dataverse table, you can use web service rules for these purposes:

  • Validate data
  • Validate and set data

Before you can set up a web service rule, set up the web service to be used.

This topic explains how to set up a web service rule.

You can find the required web service settings, to be used for the web service rule, in the technical documentation as provided by the web service provider.

Validate data

Using a web service, you can validate if a new or changed field value in a Dataverse table matches a value in another internal or external source.

Example:

Use a web service rule to validate a ZIP code and house number combination.

For request type 'POST', the request JSON is, for example:

  {

      "code":3905 NR,

      "housenumber":2

  }

 

Validate and set data

Using a web service, you can:

  1. Validate if a new or changed field value in a Dataverse table matches a value in another internal or external source.
  2. Get a field value from another internal or external source and set this value in a Dataverse table.

Example:

Use a web service rule to first validate if a ZIP code and house number combination is valid. If valid, based on the ZIP code, set address data like street name, city name, and province name.

For request type 'POST', the response JSON is, for example, when successful:

  {

      "response":true,

      "street":Kazemat,

      "city":Veenendaal,

      "province":Utrecht

  }

Note: With a web service rule, you can only set field values in Dataverse if first a validation is successfully done.

Provide feedback