Get bucket - Reality Modeling

Reality Modeling

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-modeling/itwins/{iTwinId}/bucket

Retrieve Reality Modeling 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": "90b86d36-ca6f-4d9f-a795-e3118d2a0073"
    },
    "_links": {
        "containerUrl": {
            "href": "https://cccsprodeusbsa01.blob.core.windows.net/bucket-90b86d36-ca6f-4d9f-a795-e3118d2a0073?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": "InvalidRealityModelingRequest",
        "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

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

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

Bucket

Bucket information

iTwinId

String

iTwin Id

json

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

Container URL

The URL of the container

href

String

The URL

json

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

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

message

String

A human-readable representation of the error.

json

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

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

Error

Error information.

json

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

Bucket response

_links

ContainerLinks

bucket

Bucket

json

{
    "type": "object",
    "title": "Bucket response",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/ContainerLinks"
        },
        "bucket": {
            "$ref": "#/components/schemas/Bucket"
        }
    },
    "additionalProperties": false
}

Container Links

The link to the bucket container

containerUrl

ContainerUrl

json

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

Detailed Error Response

error

DetailedError

Error Detailed information.

json

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

Was this page helpful?