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


reality-data

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-response

error

error-message

Error Response

One of a server-defined set of error codes.

code

string

A human-readable representation of the error.

message

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

Error

target

details

ErrorDetails

Error Details

ErrorResponse

---

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) project. If it has more associated projects, first [dissociate](https://developer.bentley.com/apis/reality-data/operations/dissociate-from-project/) the projects.

### 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.

### 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

OAuth access token with scope `realitydata:modify`

Authorization

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

Accept

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.

application/json;InvalidAuthorizationScheme

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

Invalid request to delete reality data. 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

---

Associates a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) to a project.

### 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.

### 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-project

projectId

Reality data successfully associated to the project

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

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

---

Dissociates a [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) from a project.

### 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.

### 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-project

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

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

---

Retrieves the list of projects associated to the specified [reality data](https://www.itwinjs.org/learning/glossary/#realitydata).

When no project is associated to the reality data, an empty list is returned.

Similarly, if the reality data does not exist, an empty list is returned. No validation is made about the existence or validity of the reality data.

### 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.

### 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-projects

OAuth access token with scope `realitydata:read`

---

Retrieves the container's link 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 `projectId` parameter is optional, but it is preferable to provide it, because the permissions used to access the container are determined from the project. With no project specified, the operation can succeed in some cases (e.g. the user is the reality data's owner), but we recommend to provide a `projectId`.

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.

### 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-container

Required access on the container (Read or Write)

access

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

Invalid request to get the container of a 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`, `classification` and `type` properties. 

Valid values for the `classification` property are: `Terrain`, `Imagery`, `Pinned`, `Model`, `Undefined`. For more details on each value, see [Reality Data Properties](https://developer.bentley.com/apis/reality-data/rd-details/) in documentation.

We recommend specifying a `projectId` in the request body, as it is used to choose the data center where the reality data is stored (the same as the project). If no `projectId` can be provided, the default data center of the organization is selected.

After creation, the reality data will be associated to the specified project.

### 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 Project or have `{permission}` permission assigned at the Project 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](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

---

Retrieves a list of [reality data](https://www.itwinjs.org/learning/glossary/#realitydata) instances belonging to the specified project.

The retrieved instances are those for which you have the required access rights, relative to the specified project. 

The `projectId` 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 `projectId` 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.

### 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 project. The operation gets all reality data in this project.

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 500, 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

Optional. Selected preferred representation.

Prefer

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 `projectId` 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 project. With no project 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 `projectId`.

### 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.

### 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 `projectId` 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 project.

With no project 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 `projectId` 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.

### 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

A reality data instance with the fields that should be updated.  ReadOnly fields should not be included.  

Delete reality data - Reality Data | iTwin Platform

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

Reality Data

Authentication

Rate limits

Request

Request parameters

Request headers

Response

Response 204 No Content

Response 401 Unauthorized

Response 404 Not Found

Response 422 Unprocessable Entity

Response 429 Too many requests

Definitions

Error Response

error-message

Error

Error Details

Error Response