Get element Presentation properties - iModel Query

iModel Query

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

GET https://dev-api.bentley.com/imodel-query/itwins/{itwin}/imodels/{imodel}/changesets/{changeset}/elements/{element}/presentation[?unitSystem]

Gets the Presentation properties of a given element.

Request parameters

itwin

Yes

iTwin ID

imodel

Yes

iModel ID

changeset

Yes

changeset ID

element

Yes

Element ID

unitSystem

Unit system to use when formatting values.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

A response

json

{
    "id": "0x200000003ba",
    "class": "Line Style",
    "label": "( Dot )",
    "items": {
        "Selected Item(s)": {
            "type": "category",
            "items": {
                "Model": {
                    "type": "primitive",
                    "value": "BisCore.DictionaryModel"
                },
                "Code": {
                    "type": "primitive",
                    "value": "( Dot )"
                },
                "User Label": {
                    "type": "primitive",
                    "value": ""
                },
                "Description": {
                    "type": "primitive",
                    "value": ""
                },
                "Data": {
                    "type": "primitive",
                    "value": "{\"compId\":665,\"compType\":3,\"flags\":3,\"unitDef\":0.0010}"
                }
            }
        }
    }
}

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

ElementPropertiesItem

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?