Get my iTwins - iTwins | iTwin Platform

REST API Overview

Reference

iTwins

Download API definition:

GET https://api.bentley.com/itwins/?subClass[&status][&type][&number][&displayName][&parentId][&iTwinAccountId][&$search][&$top][&$skip][&includeInactive]

Retrieves a list of iTwins that the calling user is a member of.

Inactive iTwins

iTwins with status=Inactive are not returned by default. This improves query performance and reduces clutter in user interfaces by filtering out unused iTwins. You should still provide a way for users to see their Inactive iTwins if they request them. In the API, you can do this by setting the status parameter or by using the includeInactive parameter.

If status=Inactive, the API will return only Inactive iTwins.
If includeInactive=true, the API will return all iTwins (Active, Trial and Inactive).

The includeInactive parameter is optional and defaults to false. A 422 error will be returned if you try to use a status parameter at the same time as the includeInactive parameter.

Authentication

Requires Authorization header with valid Bearer token for scope itwins:read.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

Any user can call this endpoint. It will only return iTwins that the user is a member of. Use the Access Control API to manage an iTwin's members.

Request

Request parameters

subClass

query

Yes

Specify a particular subClass that you wish to query on.

status

query

Specify a particular status that you wish to query on.

type

query

Specify a particular type that you wish to query on.

number

query

Find all iTwins with the exact number specified. Cannot be used at the same time as the $search parameter.

displayName

query

Find all iTwins with the exact displayName specified. Cannot be used at the same time as the $search parameter.

parentId

query

Find all iTwins that are children of the specified parentId.

iTwinAccountId

query

Find all iTwins that are owned by the specified iTwinAccountId.

$search

query

Find all iTwins that have the search string anywhere in the number or displayName. Cannot be used at the same time as the number or displayName parameters.

$top

query

The $top system query option requests the number of items in the queried collection to be included in the result.

$skip

query

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

includeInactive

query

By default, the query will not return Inactive iTwins unless you set includeInactive=true. Cannot be used at the same time as the status parameter.

Request headers

Prefer

Indicates a level of details in the response. Valid values are 'return=representation' or 'return=minimal'. The default is 'return=minimal'.

Authorization

Yes

OAuth access token with scope itwins:read

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

Response

Response 200 OK

json

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

Response 422 Unprocessable Entity

Invalid request to get iTwins

json

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

iTwin (summary)

Minimal representation of a iTwin that contains only id, class, subClass, type, number and displayName.

TableSchema

String

The iTwin Id.

class

String

The Class of your iTwin.

subClass

String

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.

iTwin

Full representation of a iTwin.

TableSchema

String

The iTwin Id.

class

String

The Class of your iTwin.

subClass

String

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.

dataCenterLocation

String

Data Center Regions.  Default is East US.

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.

iTwins (prefer return=minimal)

A list of iTwins in the minimal representation format.

TableSchema

iTwins

iTwin-summary[]

A list of iTwins in the minimal representation format.

_links

links-paging

Contains the hyperlinks to the previous and next pages of results.

iTwins (prefer return=representation)

A list of iTwins in the full representation format.

TableSchema

iTwins

iTwin[]

A list of iTwins in the full representation format.

_links

links-paging

Contains the hyperlinks to the previous and next pages of results.

links (paging)

URLs for redoing the current request, getting to the previous or next page of results, if applicable containg.

TableSchema

self

link

URL for redoing the current request.

link

URL for getting the next page of results.

link

URL for getting the previous page of results.

link

Hyperlink container.

TableSchema

href

String

Hyperlink container.

iTwin Status

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

TableSchema

No data.

Error

Contains error information and an optional array of more specific errors.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

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.

TableSchema

error

Error

Error information.