List Diff Jobs - Changed Elements

Changed Elements

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

get https://qa-api.bentley.com/changedelements/diff?iTwinId&iModelId[&startChangesetIndex][&endChangesetIndex][&startChangeset][&endChangeset][&diffingStrategy]

Returns a lightweight list of diff jobs for the specified iModel. Each entry contains identifiers, job options, and status, however, they won't contain the job results. Use the single-job GET endpoint to retrieve job results. Results can be filtered by startChangeset/endChangeset (index or Id) and/or diffingStrategy. startChangesetIndex and endChangesetIndex remain accepted as deprecated index aliases.

Request

Request parameters

iTwinId

Yes

iModelId

Yes

startChangesetIndex

Optional 1-based start changeset index. Deprecated, use startChangeset instead.

endChangesetIndex

Optional 1-based end changeset index. Deprecated, use endChangeset instead.

startChangeset

Optional 1-based start changeset index or canonical 40-character hexadecimal changeset Id.

endChangeset

Optional 1-based end changeset index or canonical 40-character hexadecimal changeset Id.

diffingStrategy

Optional. When provided, only jobs whose diffingStrategy matches this value (case-insensitive) are returned. Accepted values: "Basic", "VersionCompare", "Full".

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

List of diff jobs.

json

{
    "jobs": [{
        "jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "status": "Completed",
        "diffingStrategy": "basic",
        "iTwinId": "a1b2c3d4-0000-0000-0000-000000000000",
        "iModelId": "b2c3d4e5-0000-0000-0000-000000000000",
        "startChangesetIndex": 1,
        "endChangesetIndex": 10,
        "startChangesetId": "8e440d1976079e5b090cbb2637d1b23bd42a6a45",
        "endChangesetId": "f2a29e37b8e60d3f30b9df2f9f5c0c6a6e70c1a3"
    }]
}

Response 400 Bad Request

Invalid iTwinId or iModelId.

json

{
    "error": {
        "code": "InvalidChangedElementsRequest",
        "message": "One or more request parameters are invalid.",
        "details": [{
            "code": "InvalidParameter",
            "message": "'iTwinId' is not a valid GUID.",
            "target": "iTwinId"
        }]
    }
}

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 404 Not Found

iTwin or iModel not found.

json

{
    "error": {
        "code": "DiffJobNotFound",
        "message": "Requested DiffJob is not available."
    }
}

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
}

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
}

DiffJobSummary

Lightweight summary of a V3 diff job for list responses.

jobId

String, null

Unique identifier for this diff job.

status

String, null

iTwinId

String, null

GUID of the iTwin that owns the iModel.

iModelId

String, null

GUID of the iModel being diffed.

endChangesetId

String, null

Canonical Id of the ending changeset (inclusive). Null for legacy jobs.

diffingStrategy

String, null

startChangesetId

String, null

Canonical Id of the starting changeset (inclusive). Null for legacy jobs.

endChangesetIndex

Int32

1-based index of the ending changeset (inclusive).

startChangesetIndex

Int32

1-based index of the starting changeset (inclusive).

json

{
    "type": "object",
    "title": "DiffJobSummary",
    "required": [
        "diffingStrategy",
        "endChangesetIndex",
        "iModelId",
        "iTwinId",
        "jobId",
        "startChangesetIndex",
        "status"
    ],
    "properties": {
        "jobId": {
            "type": "string",
            "nullable": true,
            "description": "Unique identifier for this diff job."
        },
        "status": {
            "type": "string",
            "nullable": true
        },
        "iTwinId": {
            "type": "string",
            "nullable": true,
            "description": "GUID of the iTwin that owns the iModel."
        },
        "iModelId": {
            "type": "string",
            "nullable": true,
            "description": "GUID of the iModel being diffed."
        },
        "endChangesetId": {
            "type": "string",
            "nullable": true,
            "description": "Canonical Id of the ending changeset (inclusive). Null for legacy jobs."
        },
        "diffingStrategy": {
            "type": "string",
            "nullable": true
        },
        "startChangesetId": {
            "type": "string",
            "nullable": true,
            "description": "Canonical Id of the starting changeset (inclusive). Null for legacy jobs."
        },
        "endChangesetIndex": {
            "type": "integer",
            "format": "int32",
            "description": "1-based index of the ending changeset (inclusive)."
        },
        "startChangesetIndex": {
            "type": "integer",
            "format": "int32",
            "description": "1-based index of the starting changeset (inclusive)."
        }
    },
    "description": "Lightweight summary of a V3 diff job for list responses.",
    "additionalProperties": false
}

DiffJobListResponse

Response wrapper containing a list of V3 diff job summaries.

jobs

DiffJobSummary[], null

List of diff job summaries.

json

{
    "type": "object",
    "title": "DiffJobListResponse",
    "required": [
        "jobs"
    ],
    "properties": {
        "jobs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/DiffJobSummary"
            },
            "nullable": true,
            "description": "List of diff job summaries."
        }
    },
    "description": "Response wrapper containing a list of V3 diff job summaries.",
    "additionalProperties": false
}

Was this page helpful?