Table of contents
Reality Data
This API is deprecated. Please upgrade to the current version of this API as soon as possible.

Associations

Download API definition:

GET https://api.bentley.com/realitydata/{id}/projects

Retrieves the list of projects associated to the specified reality data.

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

Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have RDS_USE 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 parameters

Name
In
Required?
Description
id
template
Yes

Id of reality data

Request headers

Name
Required?
Description
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
{
    "projects": [{
        "id": "00000001-0001-0001-0001-000000000001",
        "_links": {
            "self": {
                "href": "https://api.bentley.com/projects/00000001-0001-0001-0001-000000000001"
            }
        }
    }]
}

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
{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 429 Too many requests

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

json
{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

Name
Description
retry-after

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

link

TableSchema
Name
Type
Description
href
String

Project Associated to a Reality Data

Defines a project associated to a reality data.

TableSchema
Name
Type
Description
id
String

id of associated project.

_links

The link to get the project's details

Project Details Link

TableSchema
Name
Type
Description
self

The link to get the project details.

List of Projects Associated to a Reality Data

List of all projects associated to a reality data.

TableSchema
Name
Type
Description

Error

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

TableSchema
Name
Type
Description
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.

details

Optional array of more specific errors.

Error Details

Contains error information.

TableSchema
Name
Type
Description
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
Name
Type
Description
error

Error information.