OData Metadata - Reporting

Reporting

Download API definition:

GET https://api.bentley.com/insights/reporting/odata/{reportId}/$metadata

Lists schemas for all Entities tied to a Report.

Notes

This is an OData v4 compliant endpoint.

This endpoint should only be accessed using OData compliant libraries and tools such as Power BI.

Use of these endpoints directly is not prohibited, however we recommend understanding the OData protocols and conventions first.

Authentication

Requires Authorization header with one of schemes:

Valid API Key used as the password in Basic auth.
Valid Bearer token for scope itwin-platform.

Authorization

User must have insights_view 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

reportId

Yes

The Report Id.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

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

Response

Response 200 OK

Retrieved Report OData metadata successfully.

xml

<?xml version="1.0" encoding="utf-8"?>
<edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx">
        <edmx:DataServices>
            <Schema Namespace="Insights_and_Reporting_Extractor" xmlns="http://docs.oasis-open.org/odata/ns/edm">
                <EntityType Name="EntityName">
                    <Property Name="ECInstanceId" Type="Edm.String" />
                    <Property Name="ECClassId" Type="Edm.String" />
                    <Property Name="UserLabel" Type="Edm.String" />
                    <Property Name="BBoxLow" Type="Edm.String" />
                    <Property Name="BBoxHigh" Type="Edm.String" />
                </EntityType>
            </Schema>
            <Schema Namespace="Default" xmlns="http://docs.oasis-open.org/odata/ns/edm">
                <EntityContainer Name="Container">
                    <EntitySet Name="EntityName" EntityType="Insights_and_Reporting_Extractor.EntityName" />
                </EntityContainer>
            </Schema>
        </edmx:DataServices>
</edmx:Edmx>

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 Schema was not found.

json

{
    "error": {
        "code": "SchemaNotFound",
        "message": "Requested Schema is not available."
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "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.

error

Error

Error information.

json

{
    "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?