Reality Data

Reality Data

Download API definition:

GET https://sampleHostName/realitydata/[?projectId][&continuationToken][&$top][&extent]

Retrieves a list of reality data 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 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 page.

Rate limits

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


Request parameters

Name
In
Required?
Description
projectId
query
No

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

continuationToken
query
No

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.

$top
query
No

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

extent
query
No

Extent of the area to search, delimited by southwest and northeast coordinates. Extent values are specified in this format: SouthwestCornerLongitude, SouthwestCornerLatitude, NortheastCornerLongitude, NortheastCornerLatitude. 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

Request headers

Name
Required?
Description
Prefer
No

Optional. Selected preferred representation.

Authorization
Yes

OAuth access token with scope realitydata:read

Accept
No

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

Response 200 OK

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