Get files - 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 files

get https://dev-api.bentley.com/reality-modeling/files

Retrieve list of files.

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

{
    "files": [{
        "id": "File_1",
        "name": "file 1",
        "type": "Preset",
        "description": "preset file"
    }, {
        "id": "File_2",
        "name": "file 2",
        "type": "Preset",
        "deprecated": true
    }]
}

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

This response indicates that the requested operation or resource could not be found.

json

{
    "error": {
        "code": "ResourceNotFound",
        "message": "The requested resource was not found. Verify the API URL and the Accept header.",
        "details": [{
            "code": "OperationNotFound",
            "message": "Unable to match incoming request to an operation."
        }]
    }
}

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

File

File information

String

File id

name

String

File name

type

FileTypes

deprecated

Boolean, null

Represents the file is deprecated. A deprecated file should not be used for long term, it won't be available in the future.

description

String, null

File description

json

{
    "type": "object",
    "title": "File",
    "properties": {
        "id": {
            "type": "string",
            "description": "File id"
        },
        "name": {
            "type": "string",
            "pattern": "^([^\"<>|:*?\\\\/\\u0000-\\u001f])+$",
            "maxLength": 256,
            "minLength": 3,
            "description": "File name"
        },
        "type": {
            "$ref": "#/components/schemas/FileTypes"
        },
        "deprecated": {
            "type": "boolean",
            "nullable": true,
            "description": "Represents the file is deprecated. A deprecated file should not be used for long term, it won't be available in the future."
        },
        "description": {
            "type": "string",
            "nullable": true,
            "description": "File description"
        }
    },
    "description": "File information",
    "additionalProperties": false
}

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
}

File Types

Supported file types

Preset

String

json

{
    "enum": [
        "Preset"
    ],
    "type": "string",
    "title": "File Types",
    "description": "Supported file types"
}

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
}

List of available files

List of files

files

File[]

List of files

json

{
    "type": "object",
    "title": "List of available files",
    "properties": {
        "files": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/File"
            },
            "description": "List of files"
        }
    },
    "description": "List of files",
    "additionalProperties": false
}

Was this page helpful?