Get iTwin - iTwins | iTwin Platform

REST API Overview

Reference

Changelog

iTwins

Download API definition:

Get iTwin

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

Gets the metadata of the specified iTwin.

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.

Authorization

The calling user must be a member of the specified iTwin. Use the Access Control API to manage an iTwin's members.

Request parameters

Yes

The iTwin ID

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

json

{
    "iTwin": {
        "id": "dc914a84-e0c9-40e2-9d14-faf5ed84147f",
        "class": "Endeavor",
        "subClass": "Project",
        "type": "Construction Project",
        "number": "00001-ds-3902795",
        "displayName": "White River",
        "geographicLocation": "Exton, PA",
        "latitude": 40.028,
        "longitude": -75.621,
        "ianaTimeZone": "America/New_York",
        "dataCenterLocation": "East US",
        "status": "Active",
        "parentId": "8a04f48b-1b11-475f-9b61-3083bc69f28f",
        "iTwinAccountId": "76c1102e-4f33-4dfa-ad93-bcd9ab717977",
        "imageName": "small_f3324967-82db-4c04-aad2-60635d00e1f6.png",
        "image": "https://crdeveussa01.blob.core.windows.net/context-thumbnails/small_f3324967-82db-4c04-aad2-60635d00e1f6.png?sv=2018-03-28&sr=b&sig=lcZwOExuEkdYg7KCXvrZyiVqTaRnl%2B%2F2m4ZJyj%2B5n6Y%3D&se=2023-07-07T00%3A00%3A00Z&sp=r",
        "createdDateTime": "2016-01-18T21:03:00.3704659Z",
        "createdBy": "abcd0123-e24a-4b35-9faf-f4f5f6f7f8f9",
        "lastModifiedDateTime": "2018-11-08T20:11:00.3304633Z",
        "lastModifiedBy": "abcd0123-e24a-4b35-9faf-f4f5f6f7f8f9"
    }
}

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

This response indicates that the specified iTwin was not found.

json

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

iTwin-response

iTwin

Full representation of a iTwin.

String

The iTwin Id.

class

iTwinClass

The Class of your iTwin.

subClass

iTwinSubClass

The subClass your iTwin.

type

String, null

An open ended property to better define your iTwin's Type.

number

String

A unique number or code for the iTwin. This is the value that uniquely identifies the iTwin within your organization.

displayName

String

A display name for the iTwin.

geographicLocation

String, null

An optional field specifying the location of the iTwin. This is typically an address or city.

latitude

Double, null

An optional field specifying the latitude of the iTwin.

longitude

Double, null

An optional field specifying the longitude of the iTwin.

ianaTimeZone

String, null

An optional field specifying the time zone of the iTwin. This must be a valid IANA time zone id.

dataCenterLocation

String

The data center where the data for this iTwin will be persisted. Default is East US. Valid Values: East US, North Europe, West Europe, Southeast Asia, Australia East, UK South, Canada Central, Central India, Japan East.

status

iTwinStatus

Must be one of Active, Inactive or Trial. The default value is Active. By default, Inactive iTwins are not returned from the Get my iTwins API unless requested using the includeInactive parameter.

parentId

String, null

The Id of the parent of this iTwin. For example, a Project iTwin could be a child of an Asset iTwin.

iTwinAccountId

String, null

The Id of the Account that owns this iTwin. The Account is also the root of any iTwin hierarchy.

imageName

String, null

The name of the image. The name is unique and will only change if the image changes.

image

String, null

The URL of the image. This is a small, thumbnail image that was created using the Upload iTwin Image API. The URL will be valid for a minimum of 1 hour.

createdDateTime

Date-time

The date that the iTwin was created.

createdBy

String, null

The Id of the user that created the iTwin.

lastModifiedDateTime

Date-time

The date that the iTwin was last updated.

lastModifiedBy

String, null

The Id of the user that last updated the iTwin.

iTwin Status

One of 'Active', 'Inactive', 'Trial'

Active

String

Inactive

String

Trial

String

iTwin Class

The Class of your iTwin.

Account

String

Thing

String

Endeavor

String

iTwin SubClass

The subClass your iTwin.

Account

String

Portfolio

String

Asset

String

Program

String

Project

String

WorkPackage

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.