• Get Started
  • Documentation
  • Samples
  • Blog
  • Pricing
    • Free Trial
    Table of contents
    Overview
    Available Events
    Tutorials
    Samples
    Changelog
    Changed Elements
    Download API definition:

    Changed Elements V2 API Overview

    Introduction

    The Changed Elements API helps you identify the differences in an iModel between two changesets. This API generates a comparison report that highlights the changed elements, allowing developers to integrate the results into their applications. For example, they can create color-coded visualizations to represent these changes.

    Key Features

    • Request comparison based on specific iModel changeset ranges, ensuring that only the necessary data is processed.
    • Obtain a comparison report that highlights which elements have been deleted, added, or modified.
    • Receive notifications when comparison results are ready.
    • Data processing is parallelized, allowing for faster results generation.

    Workflow

    To retrieve changes between the specified range of Changeset IDs, follow these steps:

    1. Create Comparison Job: Use the changedelements/comparisonJob endpoint to specify the start and end Changeset IDs for the range.
    2. Get Comparison Job: Use the changedelements/comparisonJob/{jobId}/itwin/{iTwinId}/imodel/{iModelId} endpoint to check the job status, or listen for the job completion event to obtain the comparison information once the job is completed.

    Use Cases

    Comparing changes in engineering data is essential for workflows in construction, architecture, engineering, and facilities management. Enhance your applications with changes timeline and detailed information for better data visualization and analysis.

    Change management and version control: Integrate change comparison results to track and compare modifications made by multiple stakeholders, ensuring the integrity of the iTwin.

    Risk mitigation and error prevention: Identify discrepancies between different versions of iModels to prevent costly errors and reduce rework and delays.

    Effective collaboration and communication: Create color-coded visualizations to highlight changes, allowing team members to understand modifications without checking individual files, thereby saving days of manual effort.

    Ensuring compliance and deliverables quality control: Comparing various iModel versions helps verify that updates comply with standards and prevents disputes among stakeholders by providing clear evidence of changes.

    Client Packages

    Open source React client package is available:

    Was this page helpful?