Reality Data

Reality Data

Download API definition:

POST https://sampleHostName/realitydata/

Creates a reality data.

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 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 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 wiki page.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.


Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope realitydata:modify

Accept
No

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

Request body

request-body-create

Name
Type
Required?
Description
No data.

Response 201 Created

Reality data successfully created

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 403 Forbidden

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

json

Response 422 Unprocessable Entity

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

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

Name
Description
retry-after

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