OData - iModels OData | iTwin Platform

REST API Overview

Overview

Samples

Reference

Changelog

iModels OData

Download API definition:

This API is deprecated. Please upgrade to the current version of this API as soon as possible.

OData

GET https://api.bentley.com/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:

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

Yes

Id of the iModel.

changesetId

Yes

Id of the Changeset.

mappingId

Yes

Id of the Mapping.

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 OData feed for a given iModel 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",
    "value": [{
        "name": "Glass",
        "url": "Glass"
    }, {
        "name": "Trees",
        "url": "Trees"
    }]
}

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

OData response

OData response.

@odata.context

Url

OData Schema

value

OData_Item[]

OData_Item

name

String

url

String

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.

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.