Skip to main content

Configuring OData Resources

The platform exposes data to external tools through its OData interface.

The platform exposes data to external tools through its OData interface. Applications such as Excel and Power BI connect to this interface to retrieve data for reporting and analysis.

No data is available through OData by default. You control what is exposed and who can access it by configuring Resources.


What is a Resource?

A Resource defines a set of objects that are made available through OData, together with the roles that are permitted to access them. Only objects included in a Resource appear in the OData feed. Only users assigned to a permitted role can query that Resource.


Create a Resource

  1. Navigate to Resources \> Resources in the Configuration application.

  2. Click New, enter a name for your resource.

  3. Add an audit comment, and click Save and Refresh.

This creates the Resource container. You then add objects and roles to it.


Add Objects to a Resource

  1. Select the Resource.

  2. In the Object panel, click Edit, then Add.

  3. Choose the objects you want to expose.

  4. Add an audit comment, and click Save and Refresh.

Any object can be added, including Virtual Objects.


Control Access with Roles

  1. Select the Resource.

  2. In the Resource Permission panel, click Edit, then Add.

  3. Select the roles that should have access.

  4. Add an audit comment, and click Save and Refresh.

Users must be assigned one of these roles to query the Resource via OData.


Units in Numeric Attributes

If an attribute has a unit of measure configured, the OData feed returns the value and unit together as a combined field — for example, 45.6 m3. Some external tools cannot separate the numeric value from the unit string.

If this causes issues with a downstream tool, you can expose the data through a Virtual Object configured without units. See Creating a Virtual Object without Units for the procedure.


OData URL

Each instance has its own OData URL. Contact support if you do not know the URL for your instance.

Did this answer your question?