Create a Web API import definition - HxGN SDx - Update 64 - Administration & Configuration

You can create a web API based import definition in the Import Mapping page of Data Validator Administration.

1. To create an import definition, click Create Import Definition on the Import Definitions toolbar.

2. In the Create New Import Definition dialog box, type a name and description for the import definition.

   You cannot create an import definition with the same name as an existing import definition.

3. Select Web API from the Import Type list.

   • In the URL Suffix text box, specify the URL suffix to be attached to the base URL during job processing. For example, to fetch the instruments from the P&ID application, you can use the following URL suffix: Sites('<SITENAME>')/Plants('<PLANTNAME>')/Instruments. This syntax will fetch all the instruments from the P&ID application.

     You can create dependent variables in the Web Client after creating the import definition in Data Validator Administration and update the URL Suffix text box with the dependent variables.

     For more information on creating dependent variables, see Create a dependent variable.

   • In the Dependent Class Definition text box, specify the dependent class definition for retrieving the data lists.

   • In the Dependent Property text box, specify the dependent properties.

   • From the Web API Definition list, select the required web API definition.

4. From the Target System box, select the target system for the new import definition. Only target systems that support validation appear in this list.

5. Select the Auto Generate Export Mapping option if you want to automatically generate the export mappings so that the column headers match the objects and properties found in the target system.

6. Select the Auto Generate Validation Rules option if you want to automatically generate the validation rules from the mapping set up in the target system. The rules are generated in Desktop Client. For more information, see Configure the automatic generation of validation rules.

7. Choose the import definition format from the Mapping Format box.

   • Basic Format - keeps the standard Import Mapping dialog layout.

   • Raw Property Format - Creates a CSV raw attribute mapping format dialog layout. For more information, see Define a raw attribute map.

8. Click Save.

The Dependent Class Definition and Dependent Property options are used when you are invoking the job definition related to the import definition using a HTTP client like Postman. For more information, see Trigger a Web API load job using a HTTP client.

If you want to view the data being fetched from the third-party applications or test your Web API Reader configuration, you can create or run a widget with the URL suffix specified in the import definition. For more information, see Create a widget.