1. Data Management
  2. Data Quality Studio on Dataverse
  3. Activities

Set up web service
Application task

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.


Standard 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. Enter a name for the web service. The name is for internal use in Data quality studio on Dataverse only. So, no match is required with the external web service name.
  In the Name field, type a value.
5. Define the URL of the web service, as provided by the web service provider.
  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. Define the authentication name to access the web service, as provided by the web service provider.
  In the Parameter Name field, enter the authentication name.
8. Define the authentication secret to access the web service, as provided by the web service provider.
  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. When you create a web service, by default, your user account is assigned as the owner.

You can assign another user account as owner.
  In the Owner field, if desired, you can make changes.
12. Subtask: Test web service.
  12.1 You can test the created web service to verify if it gives the desired results.
  In the Test Cases section, click New Web Service Test.
  12.2 Define the test request body with parameters and test values, expressed in JSON.
  In the Input Parameter field, enter a test request body.
  12.3 Define the expected response with parameters and expected response values from the web service, expressed in JSON.
  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

Related to Notes

Set up web service rule

 		 

Provide feedback