Get Comparison - Changed Elements

Changed Elements

This API is deprecated. Please upgrade to the current version of this API as soon as possible.

get https://dev-api.bentley.com/changedelements/comparison[?projectId][&iTwinId]&startChangesetId&endChangesetId&iModelId

Obtains which elements have changed in the iModel between the given start and end changesets.

This information will only be available after change tracking has been enabled and the processing operation completes.

Understanding Change

The comparison returns a ChangedElements object. This interface contains different arrays of the same size. Each element is specified by a single index in all arrays. Some of the relevant arrays to understand what changes occurred to an element are listed below:

opcodes: Contains the operation codes that tells us if the element was inserted, updated, or deleted in the change. See DbOpcode for more information. The appropriate values are listed below:

Element was deleted

Element was modified

Element was inserted

type: Contains the type of change that occurred to the element. This number is a bit-flag and can be used to know whether the element had property changes, geometric changes, placement changes, indirect changes, and hidden property changes. See TypeOfChange for more information. Below is a table with the values and their meaning:

Property

A property in the element changed

Geometry

The geometry of the element changed

Placement

The placement of the element changed. This means that the element changed its volume, origin or rotation.

Indirect

Indirect change occurred to this element by a related instance that provides properties for it

Hidden

Hidden properties of the element changed

Authentication

Requires Authorization header with valid Bearer token for scope changedelements:read.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Request

Request parameters

projectId

[Deprecated] Id of the iTwin the iModel resides in.

iTwinId

Id of the iTwin where the iModel resides.

startChangesetId

Yes

Changeset Id for the beginning of the comparison range.

endChangesetId

Yes

Changeset Id for the ending of the comparison range.

iModelId

Yes

Id of iModel to get a comparison for.

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

json

{
    "changedElements": {
        "elements": [3298534887273],
        "classIds": ["0x670"],
        "opcodes": [23],
        "modelIds": [2199023255554],
        "type": [1],
        "properties": [
            ["UserLabel"]
        ],
        "oldChecksums": [
            [1448094486]
        ],
        "newChecksums": [
            [362149254]
        ],
        "parentIds": ["0"],
        "parentClassIds": ["0"]
    }
}

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

{
    "$ref": "#/components/examples/401.HeaderNotFound.example"
}

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 provided comparison results are not ready or unexistent.

json

{
    "error": {
        "code": "ComparisonNotFound",
        "message": "Requested comparison for the given changesets is not available."
    }
}

Response 422 Unprocessable Entity

A URL parameter was malformed or there are missing required parameters.

json

{
    "error": {
        "code": "InvalidChangedElementsRequest",
        "message": "Could not get comparison.",
        "details": [{
            "code": "MissingRequiredParameter",
            "message": "Query parameter must be provided.",
            "target": "iModelId"
        }, {
            "code": "MissingRequiredParameter",
            "message": "Query parameter must be provided.",
            "target": "projectId"
        }, {
            "code": "MissingRequiredParameter",
            "message": "Query parameter must be provided.",
            "target": "startChangesetId"
        }, {
            "code": "MissingRequiredParameter",
            "message": "Query parameter must be provided.",
            "target": "endChangesetId"
        }, {
            "code": "InvalidValue",
            "message": "'abc' is not a valid 'iModelId'.",
            "target": "iModelId"
        }, {
            "code": "InvalidValue",
            "message": "'abc' is not a valid 'projectId'.",
            "target": "projectId"
        }, {
            "code": "InvalidValue",
            "message": "'abc' start changeset Id results in invalid comparison.",
            "target": "startChangesetId"
        }, {
            "code": "InvalidValue",
            "message": "'abc' end changeset Id results in invalid comparison.",
            "target": "endChangesetId"
        }]
    }
}

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

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
}

Operation Code

Operation code of change that occurred to an element. Delete: 9, Insert: 18, Update: 23.

Class Id

EC Class Id in hex string representation of an element.

Model Id

Model Id in hex string representation of a model.

Element Id

Element Id in hex string representation of an element.

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
}

Array of changed elements' type of change

changedElements.opcodes

opcode[]

Array of changed elements' operation codes

changedElements.classIds

class-id[]

Array of changed element's class Id

changedElements.elements

element-id[]

Array of changed elements' Ids

changedElements.modelIds

model-id[]

Array of changed elements' model Ids

changedElements.parentIds

element-id[]

Array of changed elements' parent Ids

changedElements.properties

element-properties[]

Array of changed elements' array of changed properties

changedElements.newChecksums

checksum-list[]

Array of changed elements' array of new checksums for each property

changedElements.oldChecksums

checksum-list[]

Array of changed elements' array of old checksums for each property

changedElements.parentClassIds

class-id[]

Array of changed elements' parent class Ids

json

{
    "type": "object",
    "title": "Changed Elements (get)",
    "properties": {
        "changedElements": {
            "type": "object",
            "title": "Changed Element Data",
            "properties": {
                "type": {
                    "type": "array",
                    "items": {
                        "$ref": "#/components/schemas/type-of-change"
                    },
                    "description": "Array of changed elements' type of change"
                },
                "opcodes": {
                    "type": "array",
                    "items": {
                        "$ref": "#/components/schemas/opcode"
                    },
                    "description": "Array of changed elements' operation codes"
                },
                "classIds": {
                    "type": "array",
                    "items": {
                        "$ref": "#/components/schemas/class-id"
                    },
                    "description": "Array of changed element's class Id"
                },
                "elements": {
                    "type": "array",
                    "items": {
                        "$ref": "#/components/schemas/element-id"
                    },
                    "description": "Array of changed elements' Ids"
                },
                "modelIds": {
                    "type": "array",
                    "items": {
                        "$ref": "#/components/schemas/model-id"
                    },
                    "description": "Array of changed elements' model Ids"
                },
                "parentIds": {
                    "type": "array",
                    "items": {
                        "$ref": "#/components/schemas/element-id"
                    },
                    "description": "Array of changed elements' parent Ids"
                },
                "properties": {
                    "type": "array",
                    "items": {
                        "$ref": "#/components/schemas/element-properties"
                    },
                    "description": "Array of changed elements' array of changed properties"
                },
                "newChecksums": {
                    "type": "array",
                    "items": {
                        "$ref": "#/components/schemas/checksum-list"
                    },
                    "description": "Array of changed elements' array of new checksums for each property"
                },
                "oldChecksums": {
                    "type": "array",
                    "items": {
                        "$ref": "#/components/schemas/checksum-list"
                    },
                    "description": "Array of changed elements' array of old checksums for each property"
                },
                "parentClassIds": {
                    "type": "array",
                    "items": {
                        "$ref": "#/components/schemas/class-id"
                    },
                    "description": "Array of changed elements' parent class Ids"
                }
            },
            "description": "Changed elements data arrays",
            "additionalProperties": false
        }
    },
    "additionalProperties": false
}

Was this page helpful?

Understanding Change

Authentication

Request

Request parameters

Request headers

Response

Response 200 OK

Response 401 Unauthorized

Response 403 Forbidden

Response 404 Not Found

Response 422 Unprocessable Entity

Response 429 Too many requests

Response headers

Definitions

Error

Operation Code

Class Id

Model Id

Element Id

Error Response

Checksum List

Type Of Change

Element Properties

Changed Elements (get)