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

GET https://qa-api.bentley.com/realitydataanalysis/detectors[?$filter]

Retrieve all available detectors.

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

$filter

No

The $filter query option requests a specific set of detectors.
The given filter is evaluated for each detector and only detectors where the filter evaluates to true are returned.
Properties supported for filtering: labels, exports.
Supported operators: and, or, not, in.
Examples of $filter values:
$filter=exports in ('Polygons', 'Lines') and labels in ('crack')
$filter=(not exports in ('Locations')) and labels in ('traffic sign')
$filter=not (exports in ('Lines') or labels in ('crack'))

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Accept

Yes

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

Response 200 OK

This response indicates that the request was successful.

json

{
    "detectors": [{
            "name": "@bentley/cracks-ortho",
            "displayName": "Cracks Ortho",
            "description": "Detects cracks in concrete infrastructure to enable defect inspection workflows.",
            "type": "OrthophotoSegmentationDetector",
            "documentationUrl": "https://www.bentley.com",
            "latestVersion": "1.0"
        },
        {
            "name": "traffic-signs",
            "displayName": "Traffic signs detector",
            "description": "Detects all traffic signs within a scene.",
            "type": "PhotoObjectDetector",
            "documentationUrl": "https://www.example.com"
        }
    ]
}

Response 400 Bad Request

The 400 (Bad Request) 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": "InvalidRealityDataAnalysisRequest",
        "message": "Cannot retrieve detectors.",
        "details": [{
            "code": "InvalidParameter",
            "message": "$filter contains an invalid or unsupported statement.",
            "target": "$filter"
        }]
    }
}

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

Detector type

Available types for AI library detectors.

PhotoObjectDetector

String

PhotoSegmentationDetector

String

OrthophotoSegmentationDetector

String

PointCloudSegmentationDetector

String

json

{
    "title": "Detector type",
    "enum": [
        "PhotoObjectDetector",
        "PhotoSegmentationDetector",
        "OrthophotoSegmentationDetector",
        "PointCloudSegmentationDetector"
    ],
    "description": "Available types for AI library detectors."
}

Reality Analysis detectors

List of available detectors.

detectors

detector-minimal[]

List of detectors.

json

{
    "title": "Reality Analysis detectors",
    "description": "List of available detectors.",
    "type": "object",
    "properties": {
        "detectors": {
            "description": "List of detectors.",
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/detector-minimal"
            }
        }
    },
    "required": [
        "detectors"
    ],
    "additionalProperties": false
}

Detector details

Details of a detector.

name

String

Name of the detector.

displayName

String

Display name of the detector.

description

String

Description of the detector.

type

detector-type

Type of the detector.

documentationUrl

String

Url of the detector's documentation.

latestVersion

String

The latest version of the detector with 'Ready' status, if any.

json

{
    "title": "Detector details",
    "description": "Details of a detector.",
    "type": "object",
    "properties": {
        "name": {
            "description": "Name of the detector.",
            "type": "string"
        },
        "displayName": {
            "description": "Display name of the detector.",
            "type": "string"
        },
        "description": {
            "description": "Description of the detector.",
            "type": "string"
        },
        "type": {
            "description": "Type of the detector.",
            "$ref": "#/components/schemas/detector-type"
        },
        "documentationUrl": {
            "description": "Url of the detector's documentation.",
            "type": "string"
        },
        "latestVersion": {
            "description": "The latest version of the detector with 'Ready' status, if any.",
            "type": "string"
        }
    },
    "required": [
        "name",
        "type"
    ],
    "additionalProperties": true
}

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

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
}

On this page

Was this page helpful?