Get a Diff Job - Changed Elements

Changed Elements

Download API definition:

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/{jobId}?iTwinId&iModelId

Returns the current status of a diff job. When status is Completed, the response includes href — a presigned Azure SAS URL to the results blob. When status is Failed, the response includes a structured error object with a curated code/message describing the failure category.

Request

Request parameters

jobId

Yes

iTwinId

Yes

iModelId

Yes

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

Diff job status and details.

json

{
    "job": {
        "jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "status": "Completed",
        "iTwinId": "a1b2c3d4-0000-0000-0000-000000000000",
        "iModelId": "b2c3d4e5-0000-0000-0000-000000000000",
        "startChangesetIndex": 0,
        "endChangesetIndex": 10,
        "diffingPlan": {
            "strategy": "Basic"
        },
        "href": "https://example.blob.core.windows.net/results.json?sv=..."
    }
}

Response 400 Bad Request

Invalid jobId, 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

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

Diff job, 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
}

DiffJob

href

String, null

Presigned Azure SAS URL to the results blob. Present only when status is Completed.

error

String, null

Error details. Present only when status is Failed.

jobId

String, null

Unique identifier for this diff job.

status

String, null

Current job status: Queued, Started, Completed, or Failed.

iTwinId

String, null

iModelId

String, null

diffingPlan

DiffingPlan

totalAgents

Int32, null

Total number of agent jobs for this diff.

completedAgents

Int32, null

Number of agent jobs that have finished processing.

endChangesetIndex

Int32

startChangesetIndex

Int32

json

{
    "type": "object",
    "title": "DiffJob",
    "required": [
        "diffingPlan",
        "endChangesetIndex",
        "iModelId",
        "iTwinId",
        "jobId",
        "startChangesetIndex",
        "status"
    ],
    "properties": {
        "href": {
            "type": "string",
            "nullable": true,
            "description": "Presigned Azure SAS URL to the results blob. Present only when status is Completed."
        },
        "error": {
            "type": "string",
            "nullable": true,
            "description": "Error details. Present only when status is Failed."
        },
        "jobId": {
            "type": "string",
            "nullable": true,
            "description": "Unique identifier for this diff job."
        },
        "status": {
            "type": "string",
            "nullable": true,
            "description": "Current job status: Queued, Started, Completed, or Failed."
        },
        "iTwinId": {
            "type": "string",
            "nullable": true
        },
        "iModelId": {
            "type": "string",
            "nullable": true
        },
        "diffingPlan": {
            "$ref": "#/components/schemas/DiffingPlan"
        },
        "totalAgents": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Total number of agent jobs for this diff."
        },
        "completedAgents": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Number of agent jobs that have finished processing."
        },
        "endChangesetIndex": {
            "type": "integer",
            "format": "int32"
        },
        "startChangesetIndex": {
            "type": "integer",
            "format": "int32"
        }
    },
    "additionalProperties": false
}

DiffingPlan

strategy

String

Diffing strategy to apply. Accepted values: "Basic", "VersionCompare", "Full" (case-insensitive).

json

{
    "type": "object",
    "title": "DiffingPlan",
    "required": [
        "strategy"
    ],
    "properties": {
        "strategy": {
            "type": "string",
            "minLength": 1,
            "description": "Diffing strategy to apply. Accepted values: \"Basic\", \"VersionCompare\", \"Full\" (case-insensitive)."
        }
    },
    "additionalProperties": false
}

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
}

DiffJobResponse

job

DiffJob

json

{
    "type": "object",
    "title": "DiffJobResponse",
    "required": [
        "job"
    ],
    "properties": {
        "job": {
            "$ref": "#/components/schemas/DiffJob"
        }
    },
    "additionalProperties": false
}

Was this page helpful?