Get iModel - iModels | iTwin Platform

iModels

Download API definition:

GET https://qa-api.bentley.com/imodels/{id}

Retrieves the metadata of an iModel.

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. If iModel Role permissions at the iModel level are configured, then user must additionally have at least imodels_webview permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have imodels_webview permission assigned at the iTwin level.

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

For more information please refer to Account Administrator documentation section on Access Control API documentation 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

Yes

iModel id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "iModel": {
        "id": "5e19bee0-3aea-4355-a9f0-c6df9989ee7d",
        "displayName": "Sun City Renewable-energy Plant",
        "dataCenterLocation": "East US",
        "name": "Sun City Renewable-energy Plant",
        "description": "Overall model of wind and solar farms in Sun City",
        "state": "initialized",
        "createdDateTime": "2020-10-20T10:51:33Z",
        "lastChangesetPushDateTime": null,
        "iTwinId": "5e19bee0-3aea-4355-a9f0-c6df9989ee7d",
        "isSecured": false,
        "extent": {
            "southWest": {
                "latitude": 46.1326770283481,
                "longitude": 7.67212000993845
            },
            "northEast": {
                "latitude": 46.3027639547812,
                "longitude": 7.83554164079782
            }
        },
        "_links": {
            "creator": {
                "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/users/42101fba-847a-4f4e-85a8-a4bed89065e4"
            },
            "changesets": {
                "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/changesets"
            },
            "namedVersions": {
                "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/namedversions"
            }
        }
    }
}

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

json

{
    "error": {
        "code": "iModelNotFound",
        "message": "Requested iModel is not available."
    }
}

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",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "additionalProperties": false,
    "description": "Hyperlink container.",
    "nullable": true
}

Point

A point on the Earth specified by a latitude and longitude.

latitude

Double

Latitude. Latitude ranges between -90 and 90 degrees, inclusive.

longitude

Double

Longitude. Longitude ranges between -180 and 180 degrees, inclusive.

json

{
    "required": [
        "longitude",
        "latitude"
    ],
    "type": "object",
    "properties": {
        "latitude": {
            "maximum": 90,
            "minimum": -90,
            "type": "number",
            "description": "Latitude. Latitude ranges between -90 and 90 degrees, inclusive.",
            "format": "double"
        },
        "longitude": {
            "maximum": 180,
            "minimum": -180,
            "type": "number",
            "description": "Longitude. Longitude ranges between -180 and 180 degrees, inclusive.",
            "format": "double"
        }
    },
    "additionalProperties": false,
    "description": "A point on the Earth specified by a latitude and longitude."
}

Extent

A rectangular area on the Earth. A rectangular area is defined by two latitudes and two longitudes that represent the four sides of a rectangular area on the Earth.

southWest

Point

northEast

Point

json

{
    "required": [
        "southWest",
        "northEast"
    ],
    "type": "object",
    "properties": {
        "southWest": {
            "$ref": "#/components/schemas/Point"
        },
        "northEast": {
            "$ref": "#/components/schemas/Point"
        }
    },
    "additionalProperties": false,
    "description": "A rectangular area on the Earth. A rectangular area is defined by two latitudes and two longitudes that represent the four sides of a rectangular area on the Earth.",
    "nullable": true
}

iModel Links

Hyperlinks to related data which complements this entity.

creator

Link

changesets

Link

namedVersions

Link

json

{
    "title": "iModel Links",
    "type": "object",
    "properties": {
        "creator": {
            "$ref": "#/components/schemas/Link"
        },
        "changesets": {
            "$ref": "#/components/schemas/Link"
        },
        "namedVersions": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false,
    "description": "Hyperlinks to related data which complements this entity."
}

iModel state

Indicates the state of the iModel. Possible values: 'initialized', 'notInitialized'.

initialized

String

notInitialized

String

json

{
    "enum": [
        "initialized",
        "notInitialized"
    ],
    "type": "string",
    "description": "Indicates the state of the iModel. Possible values: 'initialized', 'notInitialized'.",
    "title": "iModel state"
}

iModel

Full representation of the iModel.

String

Id of the iModel

displayName

String

Display name of the iModel. Corresponds to Name property.

dataCenterLocation

String

The data center where the data for this iModel is persisted. It will be the same as the iTwin data center, unless that data center is not supported or was not supported when the first iTwin iModel was created. All iTwin iModels are in the same region. Default is East US. Possible Values: Australia East, Canada Central, East US, Japan East, North Europe, South Africa North, Southeast Asia, UK South.

name

String

Name of the iModel.

description

String, null

Description of the iModel.

createdDateTime

Date-time

Date when the iModel was created.

iTwinId

String

Id of the iTwin that iModel belongs to.

isSecured

Boolean

Indicates if permissions at the iModel level are configured. true - iModel level permissions are configured. Permissions at iModel level override the iTwin level permissions. false - iModel permissions are not configured and the iTwin level permissions are applied.

extent

Extent

iModel state

iModel-state

Indicates the state of the iModel. Possible values: 'initialized', 'notInitialized'.

containersEnabled

Integer

Technology Preview property. Reserved for internal use only.

lastChangesetPushDateTime

Date-time, null

Date when the latest changeset was pushed to the iModel. This field is only set when at least one changeset has been pushed to the main branch. Null if no changeset has been pushed yet.

_links

iModelLinks

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the iModel"
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the iModel. Corresponds to Name property."
        },
        "dataCenterLocation": {
            "type": "string",
            "description": "The data center where the data for this iModel is persisted. It will be the same as the iTwin data center, unless that data center is not supported or was not supported when the first iTwin iModel was created. All iTwin iModels are in the same region. Default is East US. Possible Values: Australia East, Canada Central, East US, Japan East, North Europe, South Africa North, Southeast Asia, UK South."
        },
        "name": {
            "type": "string",
            "description": "Name of the iModel."
        },
        "description": {
            "type": "string",
            "description": "Description of the iModel.",
            "nullable": true
        },
        "createdDateTime": {
            "type": "string",
            "description": "Date when the iModel was created.",
            "format": "date-time"
        },
        "iTwinId": {
            "type": "string",
            "description": "Id of the iTwin that iModel belongs to."
        },
        "isSecured": {
            "type": "boolean",
            "description": "Indicates if permissions at the iModel level are configured. `true` - iModel level permissions are configured. Permissions at iModel level override the iTwin level permissions. `false` - iModel permissions are not configured and the iTwin level permissions are applied."
        },
        "extent": {
            "$ref": "#/components/schemas/Extent"
        },
        "state": {
            "enum": [
                "initialized",
                "notInitialized"
            ],
            "type": "string",
            "description": "Indicates the state of the iModel. Possible values: 'initialized', 'notInitialized'.",
            "title": "iModel state",
            "$ref": "#/components/schemas/iModel-state"
        },
        "containersEnabled": {
            "type": "integer",
            "description": "**Technology Preview** property. Reserved for internal use only."
        },
        "lastChangesetPushDateTime": {
            "type": "string",
            "description": "Date when the latest changeset was pushed to the iModel. This field is only set when at least one changeset has been pushed to the main branch. Null if no changeset has been pushed yet.",
            "format": "date-time",
            "nullable": true
        },
        "_links": {
            "$ref": "#/components/schemas/iModelLinks"
        }
    },
    "additionalProperties": false,
    "description": "Full representation of the iModel."
}

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

{
    "required": [
        "code",
        "message"
    ],
    "type": "object",
    "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
        }
    },
    "description": "Contains error information."
}

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

json

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

iModel Response

Container for iModel object.

iModel

json

{
    "title": "iModel Response",
    "type": "object",
    "properties": {
        "iModel": {
            "$ref": "#/components/schemas/iModel"
        }
    },
    "additionalProperties": false,
    "description": "Container for iModel object."
}

Was this page helpful?