iModels OData

Mappings

Download API definition:

GET https://sampleHostName/insights/imodels-odata/{imodelId}/changesets/{changesetId}/mappings/{mappingId}/odata

Retrieves all Groups (OData Entities) of an iModel Mapping. This endpoint can be used as an OData feed.

iModel Mappings can be managed using Reporting API.

Mapping Support

Direct data query using iModel Mapping supports a subset of available Mapping configuration options. Unsupported properties will be excluded from results.

Supported iModel Mapping configurations options:

Notes

This is an OData v4 compliant endpoint.

This endpoint should only be accessed using OData compliant libraries and tools.

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

Authentication

Requires Authorization header with valid Bearer token for scope insights:read.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

User must have imodels_webview permission assigned at the iModel level and at least imodels_webview permission assigned at the Project level. If permissions at the iModel level are not configured, then user must have imodels_webview permission assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project the iModel belongs to.

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.