Associate a reality data to a iTwin - Reality Management

Reality Management

Download API definition:

Associate a reality data to a iTwin

POST https://api.bentley.com/reality-management/reality-data/{id}/itwins/{iTwinId}

Associates a reality data to a 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.

Authorization

User must have the realitydata_create , realitydata_assign permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request

Request parameters

Yes

Id of reality data

iTwinId

Yes

Id of iTwin

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

Reality data successfully associated to the iTwin

json

{
    "iTwinAssociation": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "iTwinId": "40ddf4f1-50b9-4d68-a02e-cd711094a411"
    }
}

Response 401 Unauthorized

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

The user has insufficient permissions for the requested operation.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

This response indicates that the reality data id or the iTwin id was not found.

json

{
    "error": {
        "code": "RealityDataNotFound",
        "message": "Requested reality data is not available."
    }
}

Response 409 Conflict

This response indicates that the Association with the same iTwin already exists.

json

{
    "error": {
        "code": "AssociationExists",
        "message": "Association with the same iTwin already exists."
    }
}

Response 422 Unprocessable Entity

Invalid request to associate reality data to iTwin. Please ensure that the request is valid.

json

{
    "error": {
        "code": "InvalidRealityDataRequest",
        "message": "Invalid RealityData request.",
        "details": [{
            "code": "InvalidValue",
            "message": "The value '028cb17d-01e5-4d92-bfee-89b201a92' is not valid.",
            "target": "iTwinId"
        }]
    }
}

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

iTwin Association Response

Ids of associated iTwin and reality data.

iTwinAssociation

iTwin-association

Ids of associated iTwin and reality data.

json

{
    "type": "object",
    "title": "iTwin Association Response",
    "description": "Ids of associated iTwin and reality data.",
    "properties": {
        "iTwinAssociation": {
            "$ref": "#/components/schemas/iTwin-association",
            "description": "Ids of associated iTwin and reality data."
        }
    },
    "additionalProperties": false
}

iTwin Association

Defines an association between a reality data and a iTwin

String

id of associated reality data.

iTwinId

String

Id of associated iTwin.

json

{
    "title": "iTwin Association",
    "type": "object",
    "description": "Defines an association between a reality data and a iTwin",
    "properties": {
        "id": {
            "type": "string",
            "description": "id of associated reality data."
        },
        "iTwinId": {
            "type": "string",
            "description": "Id of associated iTwin."
        }
    },
    "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?