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
The iTwin ID
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Response 200 OK
OK
{ "iTwin": { "id": "dc914a84-e0c9-40e2-9d14-faf5ed84147f", "class": "Endeavor", "subClass": "Project", "type": "Construction Project", "number": "00001-ds-3902795", "displayName": "White River", "geographicLocation": "Exton, PA", "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" } }
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.
{ "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.
{ "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.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
The number of requests exceeds the rate-limit for the client subscription.
iTwin
Full representation of a iTwin.
The iTwin Id.
An open ended property to better define your iTwin's Type.
A unique number or code for the iTwin. This is the value that uniquely identifies the iTwin within your organization.
A display name for the iTwin.
An optional field specifying the location of the iTwin. This is typically an address or city.
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.
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.
The Id of the parent of this iTwin. For example, a Project iTwin could be a child of an Asset iTwin.
The Id of the Account that owns this iTwin. The Account is also the root of any iTwin hierarchy.
The name of the image. The name is unique and will only change if the image changes.
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.
The date that the iTwin was created.
The Id of the user that created the iTwin.
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
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.