OData Reader - EcoSys - 3.1 - Help - Hexagon

EcoSys Connect Help

Language
English
Product
EcoSys
Search by Category
Help
EcoSys Version
3.1

OData reader is used for OData Read operations.

OData reader has the following parameters:

  1. In the Basic section, you can define the name, connector, and the target URl.

    • Name – Enter a name of the reader.

    • Target URL –The available entities for the Connectors are listed. Select the entity from the list. This will be used to populate the query field. For example, if one of the Target URI selected is FDWDocuments, the query will be updated to contain FDWDocuments.

      After selecting a Target URI, the field will still display Target URI. This field is not to set a target but rather to see what is available and seed the query field.

    • Query – Enter the query to be executed. This can be manually modified. For example, FDWDocuments('6IVG003A')?$expand=SDxDocCBSWorkPackage

      The query also supports using the $__ variables such as $__PARAM() or $__STORE().

  2. In the Advanced section, the CUSTOMIZE OUTPUT FIELDS button and Response Root Path is available for all OData components that read data.

    It supports open type fields (fields that are not described in the metadata) that can be returned by an OData API call. Connect identifies such fields in the schema for mapping downstream. Click CUSTOMIZE OUTPUT FIELDS button to display the fields that Connect expects to be in the API output. To add additional fields manually, click the + button.

    For OData Response Root Path is optional.

    • If not set, it reads the structure returned from the root.

    • If set, it will read the structure from the location in the path specified which can be any place in the patch.

    To set the Response Root Path, go to the Advanced section and click on the field to select the path.