Retrieves an aggregation table.
Aggregation table represents a configuration for a single data source table aggregation. One aggregation table will result in one output table. You can have multiple aggregation tables taking data from the same data source table, but aggregation table can only take data from one data source table.
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.
Request parameters
Id of the aggregation table set.
Id of the aggregation table.
Request headers
OAuth access token with itwin-platform
scope
Setting to application/vnd.bentley.itwin-platform.v1+json
is recommended.
Response 200 OK
Retrieved AggregationTable successfully.
{ "aggregationTable": { "id": "30a58b49-0290-4c22-8d65-37c11d7c943c", "tableName": "AggregationTable_name", "description": "Aggregation of Group table `Group1`.", "sourceTableName": "Group1", "_links": { "datasource": { "href": "https://api.bentley.com/insights/reporting/datasources/imodels/70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a/mappings/f1fe5959-35ab-467e-83b8-a679b722d80f" }, "aggregationTableSet": { "href": "https://api.bentley.com/insights/reporting/datasources/aggregations/5d92982f-dea0-4290-b25c-184bec2ec7d4" } } } }
Response 401 Unauthorized
This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
Specified AggregationTable was not found.
{ "error": { "code": "AggregationTableNotFound", "message": "Requested AggregationTable is not available.", "target": "aggregationTableId" } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
Response headers
The number of requests exceeds the rate-limit for the client subscription.
Aggregation Table
Defines configuration of aggregation for a single data source table.
The aggregation table's id.
Name of the aggregation table (OData v4 SimpleIdentifier).
Description of the aggregation table.
Name of the data source table to aggregate. Source table is a group if the aggregation table set's datasourceType
is set to IModelMapping
. Value of this property must be OData v4 SimpleIdentifier.
{ "title": "Aggregation Table", "type": "object", "description": "Defines configuration of aggregation for a single data source table.", "properties": { "id": { "type": "string", "description": "The aggregation table's id." }, "tableName": { "type": "string", "description": "Name of the aggregation table (OData v4 SimpleIdentifier)." }, "description": { "type": "string", "description": "Description of the aggregation table." }, "sourceTableName": { "type": "string", "description": "Name of the data source table to aggregate. Source table is a group if the aggregation table set's `datasourceType` is set to `IModelMapping`. Value of this property must be OData v4 SimpleIdentifier." }, "_links": { "type": "object", "description": "Contains contextual hyperlinks to related data.", "properties": { "datasource": { "$ref": "#/components/schemas/Link", "description": "URL pointing to the related data source." }, "aggregationTableSet": { "$ref": "#/components/schemas/Link", "description": "URL pointing to the parent aggregation table set." } } } }, "additionalProperties": false }
Aggregation Table Response
Container for an AggregationTable object.
{ "title": "Aggregation Table Response", "type": "object", "description": "Container for an AggregationTable object.", "properties": { "aggregationTable": { "$ref": "#/components/schemas/AggregationTable", "description": "AggregationTable properties." } }, "additionalProperties": false }
Link
Hyperlink container.
Hyperlink to the specific entity.
{ "title": "Link", "type": "object", "description": "Hyperlink container.", "properties": { "href": { "type": "string", "description": "Hyperlink to the specific entity." } }, "additionalProperties": false }
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "type": "object", "description": "Contains error information.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error.", "nullable": true } }, "required": [ "code", "message" ], "additionalProperties": true }
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
{ "type": "object", "title": "Error Response", "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.", "properties": { "error": { "description": "Error information.", "$ref": "#/components/schemas/Error" } }, "required": [ "error" ], "additionalProperties": false }
Was this page helpful?