Get all aggregation properties in a given aggregation table.
Aggregation property defines how the aggregation should be done. There are 3 supported types: GroupBy
, Count
, and Sum
.
GroupBy
aggregation property type splits the data source table into groups that have matching values in the column specified in sourcePropertyName
. If you will not create a GroupBy
property our aggregator will assume that the whole data source table is one group. If you will create multiple GroupBy
properties targeting different data source properties each group will have a unique combination of those properties. See example configuration and output table T3
below.
Count
aggregation property type counts how many rows there are in a group. If the value of property specified in sourcePropertyName
contains a null
value in data source table, the row is still counted.
Sum
aggregation property type sums all values of a single property in a single group.
Examples
Let's say you have this data source table:
 Â
Then you have these aggregation table configurations:
- Aggregation properties for table
T1
:
 Â
- Aggregation properties for table
T2
:
 Â
- Aggregation properties for table
T3
:
 Â
Then your aggregated table outputs will look like this:
- Table
T1
:
 Â
- Table
T2
:
 Â
- Table
T3
:
 Â
In the T3
example you can see that groups were created for each unique pair of values in columns A
and B
.
Authentication
Requires Authorization
header with valid Bearer token for scope itwin-platform
.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Authorization
User must have imodels_read
permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled.
Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel.
An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.
Rate limits
All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.