Creates a Report Aggregation. Each one links a Aggregation to a Report and each Report can have more than one Report Aggregation.
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
, insights_modify
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
Request headers
OAuth access token with itwin-platform
scope
Setting to application/vnd.bentley.itwin-platform.v1+json
is recommended.
Request body
Report_Aggregation_Create
Id of an AggregationTableSet.
Example
{ "aggregationTableSetId": "5d92982f-dea0-4290-b25c-184bec2ec7d4" }
Response 200 OK
Created a new Report Aggregation successfully.
{ "aggregation": { "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "aggregationTableSetId": "5d92982f-dea0-4290-b25c-184bec2ec7d4", "datasourceId": "f1fe5959-35ab-467e-83b8-a679b722d80f", "datasourceType": "IModelMapping", "_links": { "report": { "href": "https://api.bentley.com/insights/reporting/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "aggregationTableSet": { "href": "https://api.bentley.com/insights/reporting/datasources/aggregations/5d92982f-dea0-4290-b25c-184bec2ec7d4" }, "datasource": { "href": "https://api.bentley.com/insights/reporting/datasources/imodels/70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a/mappings/f1fe5959-35ab-467e-83b8-a679b722d80f" } } } }
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 403 Forbidden
The user has insufficient permissions for the requested operation.
{ "error": { "code": "InsufficientPermissions", "message": "The user has insufficient permissions for the requested operation." } }
Response 404 Not Found
Specified Report was not found.
{ "error": { "code": "ReportNotFound", "message": "Requested Report is not available.", "target": "reportId" } }
Response 409 Conflict
AggregationTableSet already exists in the Report.
{ "error": { "code": "ReportAggregationExists", "message": "ReportAggregation already exists." } }
Response 422 Unprocessable Entity
The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).
{ "error": { "code": "InvalidInsightsRequest", "message": "Cannot create ReportAggregation.", "details": [{ "code": "InvalidValue", "message": "Provided 'aggregationTableSetId' value is not valid. Requested AggregationTableSet is not available.", "target": "aggregationTableSetId" }] } }
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.
Report_Aggregation_Create
Id of an AggregationTableSet.
{ "type": "object", "properties": { "aggregationTableSetId": { "type": "string", "description": "Id of an AggregationTableSet." } }, "required": [ "aggregationTableSetId" ], "additionalProperties": false }
Report_Aggregation_Single
{ "type": "object", "properties": { "aggregation": { "$ref": "#/components/schemas/Report_Aggregation", "description": "Report Aggregation properties." } }, "additionalProperties": false }
Report_Aggregation
{ "type": "object", "properties": { "reportId": { "type": "string" }, "aggregationTableSetId": { "type": "string" }, "datasourceId": { "type": "string" }, "datasourceType": { "type": "string" }, "_links": { "type": "object", "description": "Contains contextual hyperlinks to related data.", "properties": { "report": { "$ref": "#/components/schemas/Link", "description": "URL pointing to the related Report." }, "aggregationTableSet": { "$ref": "#/components/schemas/Link", "description": "URL pointing to the related AggregationTableSet." }, "datasource": { "$ref": "#/components/schemas/Link", "description": "URL pointing to the related Datasource." } } } }, "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?