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://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.

Diff job creation payload.

Request body

CreateDiffJobRequest

iTwinId

String

Yes

GUID of the iTwin that owns the iModel.

iModelId

String

Yes

GUID of the iModel to diff.

startChangesetIndex

Int32, null

A 1-based starting changeset index (inclusive).

endChangesetIndex

Int32, null

A 1-based ending changeset index (inclusive).

startChangeset

ChangesetReference

endChangeset

ChangesetReference

diffingPlan

DiffingPlan

Yes

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

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

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.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "required": [
        "code",
        "message"
    ],
    "type": "object",
    "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
        }
    },
    "description": "Contains error information."
}

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

json

{
    "title": "Error Response",
    "required": [
        "error"
    ],
    "type": "object",
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error"
        }
    },
    "additionalProperties": false,
    "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."
}

Output format identifier.

idEncoding

String, null

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

renameFields

Object, null

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

keepFields

String[], null

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

dropFields

String[], null

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

json

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

DiffingPlan

strategy

String, null

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

pipeline

PipelineStep[], null

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

output

DiffingOutputConfig

json

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

CreateDiffJobRequest

iTwinId

String

GUID of the iTwin that owns the iModel.

iModelId

String

GUID of the iModel to diff.

startChangesetIndex

Int32, null

A 1-based starting changeset index (inclusive).

endChangesetIndex

Int32, null

A 1-based ending changeset index (inclusive).

startChangeset

ChangesetReference

endChangeset

ChangesetReference

diffingPlan

DiffingPlan

json

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

DiffError

code

String, null

message

String, null

json

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

DiffJob

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.

startChangesetIndex

Int32

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

endChangesetIndex

Int32

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

startChangesetId

String, null

Canonical Id of the starting changeset (inclusive).

endChangesetId

String, null

Canonical Id of the ending changeset (inclusive).

diffingPlan

DiffingPlan

error

DiffError

href

String, null

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

completedAgents

Int32, null

Number of agent jobs that have finished processing.

totalAgents

Int32, null

Total number of agent jobs for this diff.

json

{
    "title": "DiffJob",
    "required": [
        "diffingPlan",
        "endChangesetIndex",
        "iModelId",
        "iTwinId",
        "jobId",
        "startChangesetIndex",
        "status"
    ],
    "type": "object",
    "properties": {
        "jobId": {
            "type": "string",
            "description": "Unique identifier for this diff job.",
            "nullable": true
        },
        "status": {
            "type": "string",
            "description": "Current job status: Queued, Started, Completed, or Failed.",
            "nullable": true
        },
        "iTwinId": {
            "type": "string",
            "description": "GUID of the iTwin that owns the iModel.",
            "nullable": true
        },
        "iModelId": {
            "type": "string",
            "description": "GUID of the iModel being diffed.",
            "nullable": true
        },
        "startChangesetIndex": {
            "type": "integer",
            "description": "1-based index of the starting changeset (inclusive).",
            "format": "int32"
        },
        "endChangesetIndex": {
            "type": "integer",
            "description": "1-based index of the ending changeset (inclusive).",
            "format": "int32"
        },
        "startChangesetId": {
            "type": "string",
            "description": "Canonical Id of the starting changeset (inclusive).",
            "nullable": true
        },
        "endChangesetId": {
            "type": "string",
            "description": "Canonical Id of the ending changeset (inclusive).",
            "nullable": true
        },
        "diffingPlan": {
            "$ref": "#/components/schemas/DiffingPlan"
        },
        "error": {
            "$ref": "#/components/schemas/DiffError"
        },
        "href": {
            "type": "string",
            "description": "Presigned Azure SAS URL to the results blob. Present only when status is Completed.",
            "nullable": true
        },
        "completedAgents": {
            "type": "integer",
            "description": "Number of agent jobs that have finished processing.",
            "format": "int32",
            "nullable": true
        },
        "totalAgents": {
            "type": "integer",
            "description": "Total number of agent jobs for this diff.",
            "format": "int32",
            "nullable": true
        }
    },
    "additionalProperties": false
}

DiffJobResponse

Response wrapper containing a single V3 diff job.

job

DiffJob

json

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

Was this page helpful?