Get iTwin - iTwins | iTwin Platform

iTwins

Download API definition:

Get iTwin

get https://dev-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.3704659+00:00",
        "createdBy": "abcd0123-e24a-4b35-9faf-f4f5f6f7f8f9",
        "lastModifiedDateTime": "2018-11-08T20:11:00.3304633+00:00",
        "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 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

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "additionalProperties": true
}

iTwin

Full representation of a iTwin.

String

The iTwin Id.

type

String, null

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

class

iTwinClass

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.

number

String

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

status

iTwinStatus

latitude

Double, null

An optional field specifying the latitude of the iTwin.

parentId

String, null

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

subClass

iTwinSubClass

createdBy

String, null

The Id of the user that created the iTwin.

imageName

String, null

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

longitude

Double, null

An optional field specifying the longitude of the iTwin.

displayName

String

A display name for the iTwin.

ianaTimeZone

String, null

An optional field specifying the time zone of the iTwin. This must be a valid [IANA] (https://www.iana.org/time-zones) time zone id.

iTwinAccountId

String, null

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

lastModifiedBy

String, null

The Id of the user that last updated the iTwin.

createdDateTime

Date-time

The date that the iTwin was created.

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.

geographicLocation

String, null

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

lastModifiedDateTime

Date-time

The date that the iTwin was last updated.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The iTwin Id."
        },
        "type": {
            "type": "string",
            "nullable": true,
            "maxLength": 100,
            "description": "An open ended property to better define your iTwin's Type."
        },
        "class": {
            "$ref": "#/components/schemas/iTwinClass"
        },
        "image": {
            "type": "string",
            "nullable": true,
            "description": "The URL of the image. This is a small, thumbnail image that was created using the [Upload iTwin Image API](https://developer.bentley.com/apis/operations/upload-itwin-image/). The URL will be valid for a minimum of 1 hour."
        },
        "number": {
            "type": "string",
            "maxLength": 255,
            "description": "A unique number or code for the iTwin. This is the value that uniquely identifies the iTwin within your organization."
        },
        "status": {
            "$ref": "#/components/schemas/iTwinStatus"
        },
        "latitude": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "An optional field specifying the latitude of the iTwin."
        },
        "parentId": {
            "type": "string",
            "nullable": true,
            "description": "The Id of the parent of this iTwin. For example, a Project iTwin could be a child of an Asset iTwin."
        },
        "subClass": {
            "$ref": "#/components/schemas/iTwinSubClass"
        },
        "createdBy": {
            "type": "string",
            "nullable": true,
            "description": "The Id of the user that created the iTwin."
        },
        "imageName": {
            "type": "string",
            "nullable": true,
            "description": "The name of the image. The name is unique and will only change if the image changes."
        },
        "longitude": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "An optional field specifying the longitude of the iTwin."
        },
        "displayName": {
            "type": "string",
            "maxLength": 255,
            "description": "A display name for the iTwin."
        },
        "ianaTimeZone": {
            "type": "string",
            "nullable": true,
            "description": "An optional field specifying the time zone of the iTwin. This must be a valid [IANA] (https://www.iana.org/time-zones) time zone id."
        },
        "iTwinAccountId": {
            "type": "string",
            "nullable": true,
            "description": "The Id of the Account that owns this iTwin. The Account is also the root of any iTwin hierarchy."
        },
        "lastModifiedBy": {
            "type": "string",
            "nullable": true,
            "description": "The Id of the user that last updated the iTwin."
        },
        "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date that the iTwin was created."
        },
        "dataCenterLocation": {
            "type": "string",
            "description": "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."
        },
        "geographicLocation": {
            "type": "string",
            "nullable": true,
            "maxLength": 255,
            "description": "An optional field specifying the location of the iTwin. This is typically an address or city."
        },
        "lastModifiedDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date that the iTwin was last updated."
        }
    },
    "description": "Full representation of a iTwin.",
    "additionalProperties": false
}

iTwin Class

The Class of your iTwin.

Account

String

Thing

String

Endeavor

String

json

{
    "enum": [
        "Account",
        "Thing",
        "Endeavor"
    ],
    "type": "string",
    "title": "iTwin Class",
    "description": "The [Class](https://developer.bentley.com/apis/itwins/overview/#itwinclassesandsubclasses) of your iTwin."
}

iTwin Status

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

Active

String

Inactive

String

Trial

String

json

{
    "enum": [
        "Active",
        "Inactive",
        "Trial"
    ],
    "type": "string",
    "title": "iTwin Status",
    "description": "One of 'Active', 'Inactive', 'Trial'"
}

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.

json

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

iTwin SubClass

The subClass your iTwin.

Account

String

Portfolio

String

Asset

String

Program

String

Project

String

WorkPackage

String

json

{
    "enum": [
        "Account",
        "Portfolio",
        "Asset",
        "Program",
        "Project",
        "WorkPackage"
    ],
    "type": "string",
    "title": "iTwin SubClass",
    "description": "The [subClass](https://developer.bentley.com/apis/itwins/overview/#itwinclassesandsubclasses) your iTwin."
}

iTwin-response

iTwin

json

{
    "type": "object",
    "required": [
        "iTwin"
    ],
    "properties": {
        "iTwin": {
            "$ref": "#/components/schemas/iTwin"
        }
    },
    "additionalProperties": false
}

Was this page helpful?