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

GET https://dev-api.bentley.com/reality-analysis/files

Retrieve list of available 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 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 Types

Supported file types

Preset

String

json

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

Files Response

files

File[]

List of files

json

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

File

File information.

String

Id of the file.

name

String

Name of the file.

type

FileTypes

Type of the file.

description

String

Description of the file.

deprecated

Boolean

Represents if the file is deprecated. A deprecated file should not be used for long term, it will not be available in the future.

json

{
    "title": "File",
    "description": "File information.",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the file."
        },
        "name": {
            "type": "string",
            "description": "Name of the file."
        },
        "type": {
            "$ref": "#/components/schemas/FileTypes",
            "description": "Type of the file."
        },
        "description": {
            "type": "string",
            "description": "Description of the file."
        },
        "deprecated": {
            "type": "boolean",
            "description": "Represents if the file is deprecated. A deprecated file should not be used for long term, it will not be available in the future."
        }
    },
    "required": [
        "id",
        "name",
        "type"
    ],
    "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

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",
    "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?