Rest API data point is used to configure connectivity to Restful API services. For each Restful API endpoint, a separate data point will have to be created. Same Rest API data point can be used to get responses based on different properties passed to the end point. The Rest API data point will be associated to File, JSON or XML data objects which would represent the format and structure of response from Restful API service.

To work with Web Services Data Point, follow below steps:

Step I: Create a New Data Point

Step II: Provide connection details

To connect to Web Services following details need to be provided in the Properties tab.

1. Service Type: Allows you to define the type of service that is required to connect, from Service Type drop down list, select either Rest or Soap

2. Authentication Type: Allows you to define the type of authentication that is required to connect to the Rest API service. Set it as below.

Option I: NO Auth

In this approach, no credentials need to be supplied to connect to the web-service. From Authentication Type drop down list, select NO Auth.

  • Webservices URI: Provide the end point URL to access REST API web-service.

Option II: Basic

In this approach, username and password needs to be provided for authentication. From Authentication Type drop down list, select Basic. App User and Password field will appear. Specify the user id and password respectively in these fields.

  • Webservices URI: Provide the end point URL to access REST API web-service.
  • WS-Security Authentication: Select the checkbox WS-Security Authentication and provide Tenant Name and this field is specific to SOAP service type.
  • App User: Specify the user id that will be used to connect to the Rest web service. This user should have necessary privileges to access the data in the databases
  • Password: Specify the password for the App User. To use the project parameter for the password, check the Use Project Parameters option, and you can view and select the required Project Parameter from the Password drop-down.

Note: 

  • Mandatory field names are suffixed with *. To establish the connection, provide all the mandatory property field values.
  • All the fields in the Properties tab can be parameterized using project parameters. To parameterize the fields, refer Working with Project Parameters.

Option III: Auth1.0

In this approach, there are no additional fields required.

Option IV: Auth 2.0

In this approach, the access key/token needs to be supplied to connect to the web-service. From Authentication Type drop down list, select AUTH 2.0. Access Key field will appear. Specify the key in this field.

Option V: Mutual TLS

In this approach, you can choose either to connect to webservice server without checking the certificate, or by providing the SSL certificate keys for two way authentication. From Authentication Type drop down list, select Mutual TLS.

Method 1: To connect to webservice without checking the certificate, check No Certificate Check field, and provide the end point URL to access REST API web-service.

Method 2: To connect to web-service by providing the SSL certificate keys for two way authentication, specify the Certificate related field details.

  • Webservices URI: Provide the end point URL to access REST API web-service.
  • Key Store : Specify key store path which will generate by client. ex: dicqcert.ks
  • Key Store Password: Specify password for keystore which is created while generating key store file
  • Trust Store: Specify trust store path which will generate by server. ex: ditruststore.ts
  • Trust Store Password: Specify password for trust store which is created while generating trust store file.

3.Assign Agent: To assign or change the associated agent click Change. The Change Agent window appears and displays the list of available Agents. From the list, select the required Agent Name.

Note: To search for a specific agent, enter the keyword in the search bar, and the window displays the search result list. Select the required agent and click Ok.
  • If Default agent is assigned to the Project then automatically, the Default agent will be associated with the new Data point created.
  • If Default agent is not assigned to the Project then, no agent will be assigned automatically and appropriate agent needs to be assigned to the data point.
  • When connecting to the Agent server then, the agent installation user should have appropriate privilege to access the path where file will be placed.
  • When connecting to the remote server then, the firewall needs to be opened from the Agent server to it and user specified to connect should have appropriate privilege to access the path where file will be placed.

Step III: Test the data point connection

  • To validate that the data point is able to connect to the Web Services data point database using the details provided, refer Test Data Point Connection. 

Step IV: Save the data point 

Note:

Step V: Modify the configured Extract and Web Services properties 

When moving data from one system to another the data is extracted from the source system, moved over the network and loaded into the target system. The commands generated during execution of the jobs to extract the data are generated based on the properties defined for these. The properties associated with the extraction of data should depend on the format, performance and variety of the data being moved. These properties vary based on the end point and the type of the system. Diyotta comes with default properties that covers most of the known scenarios. REST

To modify these properties, refer Editing Extract Properties in Web Services Data Point and Editing Web Services Properties in Web Services Data Point.

  • The default values for extract properties can be configured in the Admin module and these properties reflect in the Studio module.
  • The extract properties set in data point are by default used in the source and target instance of the data flow and the job flows.
  • It is a good practice to set the extract properties as per the company standards in the data point.
  • However, if needed any specific property can be overridden in the data flow or job flow.