Get bucket - Reality Analysis

Reality Analysis

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Get bucket

GET https://dev-api.bentley.com/reality-analysis/itwins/{iTwinId}/bucket

Retrieve Reality Analysis bucket for an iTwin.

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.

Request parameters

iTwinId

Yes

The iTwin Id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

json

{
    "bucket": {
        "iTwinId": "8b7c5927-6d1c-40eb-8ea8-3fa5952c0ed5"
    },
    "_links": {
        "containerUrl": {
            "href": "https://cccsprodeusbsa01.blob.core.windows.net/bucket-8b7c5927-6d1c-40eb-8ea8-3fa5952c0ed5?sv=2024-08-04&se=2025-05-30T11%3A37%3A13Z&sr=c&sp=rw&sig=**removed**"
        }
    }
}

Response 400 Bad Request

The 400 status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).

json

{
    "error": {
        "code": "InvalidRealityAnalysisRequest",
        "message": "Could not retrieve the bucket.",
        "details": [{
            "code": "InvalidProperty",
            "message": "iTwin data center location is not supported."
        }]
    }
}

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 404 Not Found

Not found

json

{
    "error": {
        "code": "iTwinNotFound",
        "message": "Requested iTwin is not available."
    }
}

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

Bucket Response

bucket

Bucket

Bucket information.

_links

ContainerLinks

The link to the container.

json

{
    "title": "Bucket Response",
    "type": "object",
    "properties": {
        "bucket": {
            "$ref": "#/components/schemas/Bucket",
            "description": "Bucket information."
        },
        "_links": {
            "$ref": "#/components/schemas/ContainerLinks",
            "description": "The link to the container."
        }
    },
    "required": [
        "bucket",
        "_links"
    ],
    "additionalProperties": false
}

Bucket

Bucket information.

iTwinId

String

iTwin Id

json

{
    "type": "object",
    "title": "Bucket",
    "description": "Bucket information.",
    "properties": {
        "iTwinId": {
            "type": "string",
            "description": "iTwin Id"
        }
    },
    "required": [
        "iTwinId"
    ],
    "additionalProperties": false
}

Container Links

The link to the bucket container.

containerUrl

ContainerUrl

The URL of the container.

json

{
    "title": "Container Links",
    "type": "object",
    "description": "The link to the bucket container.",
    "properties": {
        "containerUrl": {
            "$ref": "#/components/schemas/ContainerUrl",
            "description": "The URL of the container."
        }
    },
    "required": [
        "containerUrl"
    ],
    "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."
        }
    },
    "required": [
        "href"
    ],
    "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?