Interact with your reality data.

View, update, create, and delete reality data.


reality-management

# Reality Management API

Reality capture is the process of capturing the physical reality of an infrastructure asset, creating a representation of it, and maintaining it through continuous surveys. Reality models add real-world digital context to infrastructure iTwins. The Reality Management API provides the ability to retrieve information about the reality data that is associated with an infrastructure iTwin.

## Reality Data

Reality data properties represents the descriptive data related to a reality data. In addition to this, reality data content is stored as files and folders within a blob container uniquely associated to this reality data. Individual files and folders follow, from the root of the reality data, a normal file tree structure.

See the [Reality Data Properties](/apis/reality-management/rm-rd-details/) page for more detailed documentation.

## iTwins

Reality data are bound to iTwins. iTwins are used to represent engineering projects for an infrastructure asset. iModels, reality data, and engineering documents can be associated with a iTwin. The iTwins API is used to manage iTwins, iTwin team members, and iTwin roles. See more information in the [iTwins API Overview](/apis/itwins/overview/).

## Client Packages

Open source TypeScript client packages are available for the Reality Management API:

- @itwin/reality-data-client - [NPM registry](https://www.npmjs.com/package/@itwin/reality-data-client), [documentation](https://github.com/iTwin/reality-data-client)


---

Associates a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) to a iTwin.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydata:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `realitydata_create , realitydata_assign` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

associate-to-iTwin

iTwinId

OAuth access token with scope `realitydata:modify`

Authorization

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

Accept

Reality data successfully associated to the iTwin

default

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.

HeaderNotFound

application/json;InvalidAuthorizationScheme

InvalidAuthorizationScheme

InvalidHeaderValue

RequiredScopeMissing

Unauthorized

The user has insufficient permissions for the requested operation.

This response indicates that the reality data id or the iTwin id was not found.

This response indicates that the Association with the same iTwin already exists.

Invalid request to associate reality data to iTwin. Please ensure that the request is valid.

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

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

retry-after

---

Dissociates a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) from a iTwin.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydata:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `realitydata_create , realitydata_assign` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

dissociate-from-iTwin

This response indicates that user does not have required permissions to dissociate a reality data from iTwin.

This response indicates that the association between the reality data and iTwin was not found.

Invalid request to dissociate reality data from iTwin. Please ensure that the request is valid.

---

Retrieves the list of iTwins associated to the specified [reality data](https://www.itwinjs.org/learning/glossary/#realitydata).

When no iTwin is associated to the reality data, an empty list is returned.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydata:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `realitydata_use` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-reality-data-iTwins

OAuth access token with scope `realitydata:read`

This response indicates that user does not have required permissions to get iTwins for a reality data.

This response indicates that the requested reality data was not found.

Invalid request to get iTwins for reality data. Please ensure that the request is valid.


---
Retrieves the container's link with read access for an instance of [reality data](https://www.itwinjs.org/learning/glossary/#realitydata).

A container is where the reality data itself (a point cloud, a mesh, a collection of images, ...) is stored.

The container's link will allow you to upload/download data directly to this container.

A [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) is always associated to exactly one container.

The `iTwinId` parameter is optional, but it is preferable to provide it, because the permissions used to access the container are determined from the iTwin. With no iTwin specified, the operation can succeed in some cases (e.g. the user is the reality data's owner), but we recommend to provide a `iTwinId`.

In future API versions, containers could be hosted in in different cloud providers, but for now, only Azure cloud is supported.

To store or retrieve data from a container, refer to the [Azure Blob Storage documentation](https://docs.microsoft.com/en-us/azure/storage/blobs/).

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydata:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization
User must be an Organization Administrator for the Organization that owns a given iTwin or have realitydata_use permission for read access assigned at the iTwin level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-read-access-to-reality-data-container

This response indicates that user does not have required permissions.

This response indicates that the reality data not found.

Invalid request to get access to reality data.. Please ensure that the request is valid.


---
Retrieves the container's link with write access for an instance of [reality data](https://www.itwinjs.org/learning/glossary/#realitydata).

A container is where the reality data itself (a point cloud, a mesh, a collection of images, ...) is stored.

The container's link will allow you to upload/download data directly to this container.

A [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) is always associated to exactly one container.

The `iTwinId` parameter is optional, but it is preferable to provide it, because the permissions used to access the container are determined from the iTwin. With no iTwin specified, the operation can succeed in some cases (e.g. the user is the reality data's owner), but we recommend to provide a `iTwinId`.

In future API versions, containers could be hosted in in different cloud providers, but for now, only Azure cloud is supported.

To store or retrieve data from a container, refer to the [Azure Blob Storage documentation](https://docs.microsoft.com/en-us/azure/storage/blobs/).

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydata:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization
User must be an Organization Administrator for the Organization that owns a given iTwin or have realitydata_manage permission for write access assigned at the iTwin level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---


get-write-access-to-reality-data-container

Invalid request to get access to reality data. Please ensure that the request is valid.

---

Creates a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata).

As shown in the request section below, you must provide a request body. 

You MUST provide the `displayName` and `type` properties. 

For more details on each property, see [Reality Data Properties](https://developer.bentley.com/apis/reality-management/rm-rd-details/) in documentation.

After creation, the reality data will be associated to the specified iTwin.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydata:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `realitydata_create` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

create-reality-data

This response indicates that user does not have required permissions to create a reality data.

Invalid request to create reality data. Please ensure that the request is valid.

application/json;InvalidRealityDataRequest

InvalidRealityDataRequest

MissingRequestBody

---

Deletes a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata).

To delete a reality data, it must be associated to only one (or zero) iTwin. If it has more associated iTwins, first [dissociate](https://developer.bentley.com/apis/reality-management/operations/dissociate-from-itwin/) the iTwins.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydata:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `realitydata_manage` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

delete-reality-data

This response indicates that the specified reality data was not found.

Invalid request to delete reality data. Please ensure that the request is valid.

---

Retrieves a list of [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) instances belonging to the specified iTwin.

The retrieved instances are those for which you have the required access rights, relative to the specified iTwin. 

The `iTwinId` is optional. If you don't provide it, the retrieved [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) instances will be relative to general access rights provided by your organization. These rights are usually more restrictive, so we recommend using the `iTwinId` parameter for exhaustive results.

### Notes

The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports `"return=representation"` and `"return=minimal"` preferences.

The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request, i.e., all properties are included in the response.
The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydata:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given iTwin or must have access to context.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-all-reality-data

Id of iTwin. The operation gets all reality data in this iTwin.

Parameter that enables continuing to the next page of the previous paged query. This must be passed exactly as it is in the response body's _links.next property. If this is specified and $top is omitted, the next page will be the same size as the previous page.

continuationToken

The number of reality data to get in each page. Max 1000, but 100 is the default if this parameter is not included.

$top

Extent of the area to search, delimited by southwest and northeast coordinates. Extent values are specified in this format: SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude. E.g. to get all reality data in an area around Exton, PA, provide the following extent parameter: extent=-75.637679,40.032871,-75.633647,40.032771

extent

Parameter that enable to order reality data in ascending or descending order. Default is ascending.Example : displayName desc

$orderBy

$search

Comma separated list of reality data types. Example: "OPC,Terrain3DTiles, OMR, Cesium3DTiles" 

types

Aquisition datetime range in ISO-8601 compliant time (UTC).
Format: startDateTime/endDateTime
Example: 2021-05-12T20:03:12Z/2022-05-12T20:03:12Z

acquisitionDateTime

Created datetime range in ISO-8601 compliant time (UTC).
Format: startDateTime/endDateTime
Example: 2021-05-12T20:03:12Z/2022-05-12T20:03:12Z

createdDateTime

Parameter to get reality data with exact matching tags.

Optional. Selected preferred representation.

Prefer

minimal

representation

This response indicates that user does not have required permissions to get  reality data's from iTwin.

This response indicates that the iTwin was not found.

Invalid request to get reality data. Please ensure that the request is valid.

---

Retrieves the metadata of a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata).

The `iTwinId` parameter is optional, but it is preferable to provide it, because the permissions used to access the collection of reality data are determined from the iTwin. With no iTwin specified, the desired reality data can be retrieved (e.g. the caller is the owner), but it's more likely to get the expected result if you provide the `iTwinId`.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydata:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `realitydata_use` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

get-reality-data-details

Invalid request to get reality data details

---

Updates the metadata of a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata).

The `iTwinId` parameter is optional, but it is preferable to provide it, because the permissions used to allow the modification of the reality data are determined from the iTwin.

With no iTwin specified, it may be possible to modify the reality data (e.g. the caller is the owner), but more permissions may be granted when the `iTwinId` is provided.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydata:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `realitydata_manage` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

### Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit [Rate limits and quotas](https://developer.bentley.com/apis/overview/rate-limits/) page.

---

update-reality-data

This response indicates that user does not have required permissions to update a reality data.

Overview - Reality Management | iTwin Platform

This tutorial is an introduction to Reality Management API, explaining the basic workflows.

Get started with Reality Management API

An introduction to the Reality Management API. It covers the essential concepts required to get started.