iTwin iModels icon

iTwin iModels

Interact with iTwin Platform iModels API for managing iModels, changesets, named versions, and more

Actions54

Overview

This node interacts with the iTwin Platform's iModels API to retrieve changesets associated with a specific iModel. Changesets represent incremental updates or modifications made to an iModel over time, allowing users to track and manage version history.

Common scenarios for this node include:

  • Synchronizing local copies of iModels by fetching recent changesets.
  • Auditing or reviewing changes made to an iModel within a specified index range.
  • Paginating through large sets of changesets using continuation tokens.
  • Sorting changesets in ascending or descending order based on their index.

Practical example: A user wants to fetch all changesets for a particular iModel starting from a known index to update their local dataset incrementally without retrieving the entire history again.

Properties

Name Meaning
ID The unique identifier of the iModel whose changesets are to be retrieved. This is required.
Continuation Token A token used to retrieve the next page in a paginated response. It must be sent exactly as received from the service. To start using continuation tokens, provide an empty value initially. This option is mutually exclusive with the skip parameter (which is not exposed here).
Order By Specifies the sorting order of the returned changesets by their index property. Supported values are ascending (asc) or descending (desc). If no keyword is provided, ascending order is assumed. Example: index desc sorts changesets in descending order by index.
After Index Filters changesets to only those with an index greater than the specified value. Useful for querying changesets more recent than a known index. For example, setting afterIndex=1 returns changesets with index ≥ 2. Can be combined with lastIndex to specify a range.
Last Index Filters changesets to only those with an index less than or equal to the specified value. For example, lastIndex=10 returns changesets with index ≤ 10. Can be combined with afterIndex to specify a range.

Output

The node outputs an array of JSON objects representing changesets retrieved from the iModel. Each changeset object typically includes metadata such as its index, id, description, timestamp, and other relevant details describing the change.

If multiple changesets are returned, each is output as a separate item in the node's output array under the json field.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API authentication credential configured in n8n to access the iTwin Platform iModels API.
  • The node depends on the iTwin Platform's REST API endpoint for changesets.
  • Proper network connectivity and valid permissions on the iModel are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing iModel ID will cause the request to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Using both continuation token and skip parameters simultaneously is not allowed; ensure only one pagination method is used.
    • Providing invalid query parameter values (e.g., non-numeric indices) may cause API errors.

  • Error messages:

    • "Unknown operation": Indicates the operation name was not recognized; verify that "Get iModel Changesets" is selected.
    • Authentication errors: Check that the API key or OAuth token is correctly configured and has sufficient permissions.
    • Pagination errors related to continuation tokens: Ensure the token is passed exactly as received from the previous response.

Links and References

Discussion