Retrieve read access to reality data container - Reality Management

Reality Management

Download API definition:

Retrieve read access to reality data container

GET https://api.bentley.com/reality-management/reality-data/{id}/readaccess[?iTwinId]

Retrieves the container's link with read access for an instance of reality data.

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

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

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

Request

Request parameters

Yes

Id of reality data

iTwinId

Id of iTwin.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "type": "AzureBlobSasUrl",
    "access": "Read",
    "_links": {
        "containerUrl": {
            "href": "https://realityprodneusa01.blob.core.windows.net/78e3a82d-076e-4d1d-b8ef-ab0625fbb856?sv=2020-08-04&se=2021-07-22T03%3A50%3A21Z&sr=c&sp=rl&sig=**removed**"
        }
    }
}

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

This response indicates that user does not have required permissions.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

This response indicates that the reality data not found.

json

{
    "error": {
        "code": "RealityDataNotFound",
        "message": "Requested reality data is not available."
    }
}

Response 422 Unprocessable Entity

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

json

{
    "error": {
        "code": "InvalidRealityDataRequest",
        "message": "Invalid RealityData request.",
        "details": [{
            "code": "InvalidValue",
            "message": "The value '028cb17d-01e5-4d92-bfee-89b201a922' is not valid.",
            "target": "id"
        }]
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Container Details Response

Container for a reality data.

type

String

Type of container. Currently, only 'AzureBlobSasUrl' is supported.

access

String

Type of access user have to container.

_links

container-links

The link to the container

json

{
    "type": "object",
    "title": "Container Details Response",
    "description": "Container for a reality data.",
    "properties": {
        "type": {
            "type": "string",
            "description": "Type of container. Currently, only 'AzureBlobSasUrl' is supported."
        },
        "access": {
            "type": "string",
            "description": "Type of access user have to container."
        },
        "_links": {
            "$ref": "#/components/schemas/container-links",
            "description": "The link to the container"
        }
    },
    "additionalProperties": false
}

Container Links

The link to the container

containerUrl

container-url

The URL of the container

json

{
    "title": "Container Links",
    "type": "object",
    "description": "The link to the container",
    "properties": {
        "containerUrl": {
            "$ref": "#/components/schemas/container-url",
            "description": "The URL of the container"
        }
    },
    "additionalProperties": false
}

Container URL

The URL of the container

href

String

The URL

json

{
    "title": "Container URL",
    "type": "object",
    "description": "The URL of the container",
    "properties": {
        "href": {
            "type": "string",
            "description": "The URL"
        }
    },
    "additionalProperties": false
}

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

json

{
    "type": "object",
    "description": "Contains error information and an array of more specific errors.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        },
        "details": {
            "type": "array",
            "description": "Optional array of more specific errors.",
            "items": {
                "$ref": "#/components/schemas/Error"
            }
        }
    },
    "required": [
        "code",
        "message",
        "details"
    ],
    "additionalProperties": true
}

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

error

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed Error Response",
    "description": "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.",
    "properties": {
        "error": {
            "description": "Error Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

Error Response

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?