Skip to main content

OData

This section explains how to connect to a source using OData. Before creating a Function, ensure you have already created the corresponding System within a System Line.

Connect to an OData source​

In order to connect to an ODate source, create a new Function in the menu 'Virtual Datasets' and directly assign it to a Category.
Afterwards select the Technical Handler 'OData'.
All other configuration (e. g. a descriptive Short Name and Description) has to be done as usual. If "Configure on Function" is set as Authentication in the System configuration, then do not forget to also setup the Authentication in the Function configuration.
For the Technical Parameters, please specify the following options. The options in BOLD are REQUIRED:

  • PROPERTIES: List of properties to be returned by the query, separated by semicolons. Use '*' to return all properties.

  • RESOURCE_PATH: The Resource Path for the requested Entity (e. g. Accounts ).

  • SERVICE_ROOT_URL: The Service Root URL for the OData Service (e.g. https://hostname.com/api/data/v1.0/ ).

Parameter​

  • PROPERTY_FILTER: Parameter to filter on property values.
    • Cardinality: all
    • Data Type: all
    • Additional Properties:
      • PROPERTY_NAME: Name of the property to be filtered on. If empty, the name of the parameter will be used.