OData Entity - iModels OData

REST API Overview

Reference

iModels OData

Download API definition:

GET https://api.bentley.com/insights/imodels-odata/{imodelId}/changesets/{changesetId}/mappings/{mappingId}/odata/{groupName}[?$top][&$skip][&$select][&$filter]

Lists the data for a Group and selected Properties.

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:

Group - All query types supported
GroupProperty - All property selection supported
CalculatedProperty - All calculations are supported
CustomCalculation - All operators supported

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 itwin-platform.

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

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.

Request

Request parameters

imodelId

template

Yes

Id of the iModel.

changesetId

template

Yes

Id of the Changeset.

mappingId

template

Yes

Id of the Mapping.

groupName

template

Yes

Name of the Group.

$top

query

The $top query option requests the number of items in the queried collection to be included in the result.

$skip

query

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$select

query

The $select query option requests a specific set of properties for each entity.
The value of $select is a comma separated list of property names to select. All properties are selected if it is not set or set to *.

$filter

query

The $filter query option requests a specific set of entities.
The given filter is evaluated for each entity and only entities where the filter evaluates to true are returned.
Properties supported for filtering: ECInstanceId, ECClassId.
Supported operators: eq, lt, le, gt, ge, ne, in, and, or.
Parenthesis ( and ) can be used to change the precedence of operations.
Examples of $filter values:
$filter=ECInstanceId eq 0x123
$filter=ECInstanceId in (0x123, 0x234, 0x345)
$filter=ECInstanceId gt 0x1 and ECInstanceId lt 0x5
$filter=ECInstanceId eq 0x123 or ECInstanceId eq 0x456
$filter=ECClassId eq 0x5
$filter=ECClassId eq 'BisCore.GeometricElement3d'

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 specified OData Entity successfully.

json

{
    "@odata.context": "https://api.bentley.com/insights/imodels-odata/202b3aef-3856-4472-b27e-215b0597fd01/changesets/d525c4c77f22f44b694dcce8c86462b10bd9725f/mappings/a591b060-cf5a-4b66-a3f6-27965df8d28f/odata/$metadata#Glass",
    "@odata.nextLink": "https://api.bentley.com/insights/imodels-odata/202b3aef-3856-4472-b27e-215b0597fd01/changesets/d525c4c77f22f44b694dcce8c86462b10bd9725f/mappings/a591b060-cf5a-4b66-a3f6-27965df8d28f/odata/Glass?$top=3&$skip=3",
    "value": [{
        "ECInstanceId": "0xa9",
        "ECClassId": "Architecture",
        "UserLabel": "System Panel Glazed",
        "BBoxLow": null,
        "BBoxHigh": null,
        "Area": 1.1032236000001379,
        "Height": 0.3810000000000477,
        "Width": 2.8956
    }, {
        "ECInstanceId": "0xac",
        "ECClassId": "Architecture",
        "UserLabel": "System Panel Glazed",
        "BBoxLow": null,
        "BBoxHigh": null,
        "Area": 0.5225796000000649,
        "Height": 0.3810000000000477,
        "Width": 1.371599999999999
    }, {
        "ECInstanceId": "0xaf",
        "ECClassId": "Architecture",
        "UserLabel": "System Panel Glazed",
        "BBoxLow": null,
        "BBoxHigh": null,
        "Area": 0.2903220000000363,
        "Height": 0.3810000000000477,
        "Width": 0.762
    }]
}

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

json

{
    "error": {
        "code": "EntityNotFound",
        "message": "Requested Entity 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

OData Entity response

OData Entity response.

TableSchema

@odata.context

Url

OData Schema

@odata.nextLink

Url

value

Object[]

Error

Contains error information.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

The target of the error.

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.

TableSchema

error

Error

Error information.