Get AggregationTables - Reporting

Reporting

Download API definition:

This operation is a Technical Preview and is available for testing purposes only. Do not use in production.

get https://dev-api.bentley.com/insights/reporting/datasources/aggregations/{aggregationTableSetId}/tables[?$top][&$continuationToken]

Get all aggregation tables for a given aggregation table set id.

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

Request parameters

aggregationTableSetId

Yes

Id of the aggregation table set.

$top

Optional max items to be sent in response.

$continuationToken

Optional token to retrieve next page in paginated response.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Response

Response 200 OK

Retrieved AggregationTables successfully.

json

{
    "aggregationTables": [{
        "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"
            }
        }
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/insights/reporting/datasources/aggregations/5d92982f-dea0-4290-b25c-184bec2ec7d4/tables?$top=1&$continuationToken=ddac51e3-3d37-4407-816e-52b9fc80d70a"
        },
        "self": {
            "href": "https://api.bentley.com/insights/reporting/datasources/aggregations/5d92982f-dea0-4290-b25c-184bec2ec7d4/tables?$top=1"
        }
    }
}

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.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

Specified AggregationTableSet was not found.

json

{
    "error": {
        "code": "AggregationTableSetNotFound",
        "message": "Requested AggregationTableSet is not available.",
        "target": "aggregationTableSetId"
    }
}

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).

json

{
    "error": {
        "code": "InvalidInsightsRequest",
        "message": "Cannot retrieve AggregationTables.",
        "details": [{
            "code": "InvalidParameter",
            "message": "Provided '$top' query parameter value is not valid. Expected a value of type 'number'.",
            "target": "$top"
        }]
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "type": "object",
    "title": "Link",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "description": "Hyperlink container.",
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "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.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "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.",
    "additionalProperties": false
}

Aggregation Table

Defines configuration of aggregation for a single data source table.

String

The aggregation table's id.

_links.datasource

Link

_links.aggregationTableSet

Link

tableName

String

Name of the aggregation table (OData v4 SimpleIdentifier).

description

String

Description of the aggregation table.

sourceTableName

String

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.

json

{
    "type": "object",
    "title": "Aggregation Table",
    "properties": {
        "id": {
            "type": "string",
            "description": "The aggregation table's id."
        },
        "_links": {
            "type": "object",
            "properties": {
                "datasource": {
                    "$ref": "#/components/schemas/Link"
                },
                "aggregationTableSet": {
                    "$ref": "#/components/schemas/Link"
                }
            },
            "description": "Contains contextual hyperlinks to related data."
        },
        "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."
        }
    },
    "description": "Defines configuration of aggregation for a single data source table.",
    "additionalProperties": false
}

Paged Response Links

URLs for redoing the current request and/or getting the next page of results if applicable.

Link

self

Link

json

{
    "type": "object",
    "title": "Paged Response Links",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/Link"
        },
        "self": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "description": "URLs for redoing the current request and/or getting the next page of results if applicable.",
    "additionalProperties": false
}

Aggregation Table Collection

Container for a list of AggregationTable objects.

_links

PagedResponseLinks

aggregationTables

AggregationTable[]

List of AggregationTable objects.

json

{
    "type": "object",
    "title": "Aggregation Table Collection",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/PagedResponseLinks"
        },
        "aggregationTables": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/AggregationTable"
            },
            "description": "List of AggregationTable objects."
        }
    },
    "description": "Container for a list of AggregationTable objects.",
    "additionalProperties": false
}

Was this page helpful?