Create a Diff Job - Changed Elements

Changed Elements

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

post https://qa-api.bentley.com/changedelements/diff

Queues a new diff job for the specified iModel changeset range using either a named diffing strategy or a custom diffing pipeline. Returns 409 if a job with identical parameters already exists. Delete the existing job first to retry.

Request

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

CreateDiffJobRequest

iTwinId

String

Yes

GUID of the iTwin that owns the iModel.

iModelId

String

Yes

GUID of the iModel to diff.

diffingPlan

DiffingPlan

Yes

endChangeset

ChangesetReference

startChangeset

ChangesetReference

endChangesetIndex

Int32, null

A 1-based ending changeset index (inclusive).

startChangesetIndex

Int32, null

A 1-based starting changeset index (inclusive).

Example

json

{
    "iTwinId": "a1b2c3d4-0000-0000-0000-000000000000",
    "iModelId": "b2c3d4e5-0000-0000-0000-000000000000",
    "startChangeset": 1,
    "endChangeset": 10,
    "diffingPlan": {
        "strategy": "Basic"
    }
}

Response

Response 202 Accepted

Diff job created and queued.

json

{
    "job": {
        "jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "status": "Queued",
        "iTwinId": "a1b2c3d4-0000-0000-0000-000000000000",
        "iModelId": "b2c3d4e5-0000-0000-0000-000000000000",
        "startChangesetIndex": 1,
        "endChangesetIndex": 10,
        "startChangesetId": "8e440d1976079e5b090cbb2637d1b23bd42a6a45",
        "endChangesetId": "f2a29e37b8e60d3f30b9df2f9f5c0c6a6e70c1a3",
        "diffingPlan": {
            "strategy": "Basic"
        }
    }
}

Response 400 Bad Request

Invalid request parameters or index range.

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

Caller does not have read access to the iTwin or iModel.

json

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

Response 404 Not Found

iTwin, iModel, or one of the changeset indices was not found.

json

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

Response 409 Conflict

A job with identical parameters already exists. Delete the existing job to retry.

json

{
    "error": {
        "code": "DiffJobExists",
        "message": "A diff job with identical parameters already exists. Delete the existing job to retry."
    }
}

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

DiffError

jobId

String, null

Unique identifier for this diff job.

status

String, null

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

iTwinId

String, null

GUID of the iTwin that owns the iModel.

iModelId

String, null

GUID of the iModel being diffed.

diffingPlan

DiffingPlan

totalAgents

Int32, null

Total number of agent jobs for this diff.

endChangesetId

String, null

Canonical Id of the ending changeset (inclusive).

completedAgents

Int32, null

Number of agent jobs that have finished processing.

startChangesetId

String, null

Canonical Id of the starting changeset (inclusive).

endChangesetIndex

Int32

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

startChangesetIndex

Int32

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

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": {
            "$ref": "#/components/schemas/DiffError"
        },
        "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,
            "description": "GUID of the iTwin that owns the iModel."
        },
        "iModelId": {
            "type": "string",
            "nullable": true,
            "description": "GUID of the iModel being diffed."
        },
        "diffingPlan": {
            "$ref": "#/components/schemas/DiffingPlan"
        },
        "totalAgents": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Total number of agent jobs for this diff."
        },
        "endChangesetId": {
            "type": "string",
            "nullable": true,
            "description": "Canonical Id of the ending changeset (inclusive)."
        },
        "completedAgents": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Number of agent jobs that have finished processing."
        },
        "startChangesetId": {
            "type": "string",
            "nullable": true,
            "description": "Canonical Id of the starting changeset (inclusive)."
        },
        "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)."
        }
    },
    "additionalProperties": false
}

DiffError

code

String, null

message

String, null

json

{
    "type": "object",
    "title": "DiffError",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "nullable": true
        },
        "message": {
            "type": "string",
            "nullable": true
        }
    },
    "additionalProperties": false
}

DiffingPlan

output

DiffingOutputConfig

pipeline

PipelineStep[], null

Ordered list of pipeline processing steps. Mutually exclusive with 'strategy'.

strategy

String, null

Diffing strategy to apply. Accepted values: "Basic", "VersionCompare", "Full" (case-insensitive). Mutually exclusive with 'pipeline'.

json

{
    "type": "object",
    "title": "DiffingPlan",
    "properties": {
        "output": {
            "$ref": "#/components/schemas/DiffingOutputConfig"
        },
        "pipeline": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/PipelineStep"
            },
            "nullable": true,
            "description": "Ordered list of pipeline processing steps. Mutually exclusive with 'strategy'."
        },
        "strategy": {
            "type": "string",
            "nullable": true,
            "description": "Diffing strategy to apply. Accepted values: \"Basic\", \"VersionCompare\", \"Full\" (case-insensitive). Mutually exclusive with 'pipeline'."
        }
    },
    "additionalProperties": false
}

PipelineStep

A single step in a diffing pipeline. Either a generic step with a name and optional config, or a strategy reference.

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

Response wrapper containing a single V3 diff job.

job

DiffJob

json

{
    "type": "object",
    "title": "DiffJobResponse",
    "required": [
        "job"
    ],
    "properties": {
        "job": {
            "$ref": "#/components/schemas/DiffJob"
        }
    },
    "description": "Response wrapper containing a single V3 diff job.",
    "additionalProperties": false
}

ChangesetReference

DiffingOutputConfig

format

String, null

Output format identifier.

dropFields

String[], null

List of field names to exclude from the output. Mutually exclusive with 'keepFields'.

idEncoding

String, null

Optional element id encoding in output. Accepted values: "hex" or "decimal" (case-insensitive).

keepFields

String[], null

List of field names to include in the output. Mutually exclusive with 'dropFields'.

renameFields

Object, null

Field renaming map. Keys are original field names, values are the desired output names.

json

{
    "type": "object",
    "title": "DiffingOutputConfig",
    "properties": {
        "format": {
            "type": "string",
            "nullable": true,
            "description": "Output format identifier."
        },
        "dropFields": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "nullable": true,
            "description": "List of field names to exclude from the output. Mutually exclusive with 'keepFields'."
        },
        "idEncoding": {
            "type": "string",
            "nullable": true,
            "description": "Optional element id encoding in output. Accepted values: \"hex\" or \"decimal\" (case-insensitive)."
        },
        "keepFields": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "nullable": true,
            "description": "List of field names to include in the output. Mutually exclusive with 'dropFields'."
        },
        "renameFields": {
            "type": "object",
            "nullable": true,
            "description": "Field renaming map. Keys are original field names, values are the desired output names.",
            "additionalProperties": {
                "type": "string"
            }
        }
    },
    "additionalProperties": false
}

CreateDiffJobRequest

iTwinId

String

GUID of the iTwin that owns the iModel.

iModelId

String

GUID of the iModel to diff.

diffingPlan

DiffingPlan

endChangeset

ChangesetReference

startChangeset

ChangesetReference

endChangesetIndex

Int32, null

A 1-based ending changeset index (inclusive).

startChangesetIndex

Int32, null

A 1-based starting changeset index (inclusive).

json

{
    "type": "object",
    "title": "CreateDiffJobRequest",
    "required": [
        "diffingPlan",
        "iModelId",
        "iTwinId"
    ],
    "properties": {
        "iTwinId": {
            "type": "string",
            "minLength": 1,
            "description": "GUID of the iTwin that owns the iModel."
        },
        "iModelId": {
            "type": "string",
            "minLength": 1,
            "description": "GUID of the iModel to diff."
        },
        "diffingPlan": {
            "$ref": "#/components/schemas/DiffingPlan"
        },
        "endChangeset": {
            "$ref": "#/components/schemas/ChangesetReference"
        },
        "startChangeset": {
            "$ref": "#/components/schemas/ChangesetReference"
        },
        "endChangesetIndex": {
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 1,
            "nullable": true,
            "deprecated": true,
            "description": "A 1-based ending changeset index (inclusive)."
        },
        "startChangesetIndex": {
            "type": "integer",
            "format": "int32",
            "maximum": 2147483647,
            "minimum": 1,
            "nullable": true,
            "deprecated": true,
            "description": "A 1-based starting changeset index (inclusive)."
        }
    },
    "additionalProperties": false
}

Was this page helpful?