Create an OData data source
A Data Source represents one OData API. Every dataset you create underneath it queries that API, using the data source's API Auth Profile.
Before you start
You'll need the API's service root URL (the OData endpoint) and an API Auth Profile for it. Create the profile first if you haven't already.
Steps
-
Create the data source
In the back office, open the menu on the Data Sources folder (or a sub-folder) and create a Data Source. Name it after the system, such as Aptem.
-
Enter the OData Endpoint
In OData Endpoint, enter the API's service root URL, for example
https://api.example.com/odata. Don't include an entity set name; each dataset adds its own. -
Pick the API Auth Profile
In API Auth Profile, pick the profile that holds this API's credentials.
-
Save, publish and test
Save and publish, then select Test Connection to check the profile's credentials are in place.
More detail
Good to know
- AutomatedOn sends standard OData version 4 requests, asks for JSON, and follows the API's own next-page links, so you get every matching record.
- The endpoint must be reachable on the public internet. Internal and private addresses are blocked.
- If the Entity Set list shows OData query failed (...) with a status and message, the API rejected the request. A 401 or 403 status usually means the credentials or their permissions need checking.
What happens next
Create datasets underneath the data source. When you create a Dataset, its Entity Set list is filled from the API itself. If that list loads, AutomatedOn can reach the API and sign in.