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, specifically to create a new Changeset Group within an iModel. A Changeset Group is a collection of changesets that can be managed together, useful for organizing and tracking sets of changes in an iModel project.

Typical use cases include:

  • Automating the creation of changeset groups during development workflows.
  • Organizing changesets by feature or milestone in a version control process.
  • Integrating with CI/CD pipelines to group changesets related to specific builds or releases.

For example, a user might create a changeset group named "Feature X Updates" with a description summarizing the purpose, helping team members understand the context of grouped changes.

Properties

Name Meaning
ID The unique identifier of the iModel where the changeset group will be created.
Description A textual description of the new Changeset Group (up to 255 characters). Describes the purpose or contents of the group.
Options Additional options including:
   Custom Payload Allows overriding the request body with a custom JSON payload instead of using the standard parameters. Useful for advanced or unsupported API calls.

Output

The node outputs JSON data representing the newly created Changeset Group as returned by the iTwin Platform API. This typically includes details such as the group's ID, description, and metadata confirming successful creation.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Platform API.
  • Needs proper configuration of OAuth2 credentials or equivalent API authentication in n8n.
  • Depends on the bundled IModelsOpenApiInterpreter module to interpret and execute API operations.

Troubleshooting

  • Common issues:

    • Invalid or missing iModel ID: Ensure the provided iModel ID exists and is correctly formatted.
    • Description too long: The description must not exceed 255 characters.
    • Authentication errors: Verify that the API key or OAuth2 credentials are valid and have sufficient permissions.
    • Network or API availability issues: Check connectivity and iTwin Platform service status.
  • Error messages:

    • "Unknown operation": Indicates the specified operation name is incorrect or unsupported.
    • API error responses will be passed through; check the message for details like invalid parameters or permission denied.
    • If continueOnFail is enabled, errors will be included in the output JSON under an error field for easier debugging.

Links and References

Discussion