OData

❗️

Contact your sales representative if you are interested in obtaining a license for the OData module for your SmartIQ instance.

Create a new Data Connector in SmartIQ to consume RESTful APIs using the OData version 4 protocol.

Setting Up the OData Data Connection

1. Go to Manage > Data Connections > New Data Connection and select OData Connection Type from the drop-down menu.

2. In the New Data Connection screen, configure the following:

3. Specify the name of the data connection and select OData as the Connection Type.
4. Select the OData setting from the drop-down menu.
5. In Connection Attributes, specify values that will overwrite a specific setting for a particular data connection. For example,

serviceRootURL=https://services.odata.org/Experimental/Northwind/Northwind.svc;maxNavigationDepth=3;maxComplexDepth=5;

If left blank, the data connection will use the values configured in Manage > Settings.

📘

Authentication

OData supports username and password authentication as well as bearer tokens. To use a bearer access token, add a bearer=[AccessToken] as a parameter in the Connection Attributes and set the Credentials to "No credentials required".

6. Configure the Credentials.
7. Click Test Connection to verify connection with the endpoint.
8. Click Save.

Setting Up the Data Objects

1. Click New Data Objects and start typing the data object name and you will get an auto-complete of the available objects. Select the one you want.
2. Specify a display name.
3. Click Save.

4. Configure which fields are available to be filtered and displayed within Design.

📘

Notes

• Fields that start with a forward slash / indicate that it's a navigation properties on the field. Navigation Properties can be nested down to the maxNavigationDepth. For example, /ProductDetails/Product/Supplier.Name
• Fields separated with a period(.) indicate a complex type. For example, Address.State, Address.City, Addresss.Street
• Fields that end with square brackets [] indicate a collection and can be set up as a hierarchical data structure.