Please note - The grouping structure limitation is currently under development and is due to be released to all customers in the first April 2025 release. This is to enhance the security of our data access.
Overview
This article documents how users can generate an OData token which allows them to access the OData feeds used for reporting. This token is generated in classic only by the Admin user type.
This article also explains how OData feeds accessed via APIs are limited via the grouping structure within Aptem. This limitation ensures the security and data integrity of the OData feeds.
Configuration/ Set Up Prerequisites
The API token will reflect the configured group hierarchy, ensuring data access aligns with assigned groups. This grouping structure should be defined before the Admins generate the OData token and access the feeds to ensure the security of data.
Generating the Token
- Group hierarchy documentation can be found here: Groups
- To generate an OData token the following steps can be taken by Admin user types.
- Navigate to Classic
- Select the Admin name within the user's table
- This will navigate you to their User Profile
- Select the ‘Generate API token’ option in the API token section.
- This will generate the API token allowing you to access the OData feeds. The API token will then be displayed in the ‘API token’ drop-down section.
- Once this API token is generated the Admin will be able to access the OData as described in: Getting data from OData collections in Excel and PowerBI
- The Admin will only be able to access data via these feeds in accordance with their group-level access. Any data relating to users within groups this Admin is not associated with will not be accessible and will not be returned.
- This also applies to these Admins accessing data via PowerBI reports.