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 iModels API, specifically allowing users to add an iModel to their "My Recents" list. This operation is useful for keeping track of frequently accessed or important iModels by adding them to a personalized recent list within the iTwin ecosystem.

Common scenarios include:

  • Automatically updating a user's recent iModels after opening or modifying an iModel.
  • Integrating with workflows that manage iModel access and want to maintain a quick-access list.
  • Enhancing user experience by programmatically managing recents without manual intervention.

Example: After processing an iModel in an automated workflow, this node can add that iModel to the user's recents so it appears quickly in their iTwin interface.

Properties

Name Meaning
ID The unique identifier of the iModel to add to the recents list.
Options Additional options for the request:
  Custom Payload Allows overriding the default request body with a custom JSON payload. If enabled, the provided JSON will be sent instead of the standard request format.

Output

The node outputs JSON data representing the response from the iTwin Platform API after attempting to add the specified iModel to the user's recents. The structure typically contains confirmation details or status information about the addition.

If a custom payload is used, the output reflects the API's response to that payload.

No binary data output is produced by this node.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate with the iTwin Platform.
  • Depends on the iTwin Platform's iModels API being accessible and the authenticated user having permissions to modify their recents.
  • Uses an internal OpenAPI interpreter module to handle API operations.

Troubleshooting

  • Common issues:

    • Invalid or missing iModel ID: Ensure the "ID" property is correctly set to a valid iModel identifier.
    • Authentication errors: Verify that the API key or OAuth2 credentials are properly configured and have sufficient permissions.
    • API connectivity problems: Check network access to the iTwin Platform API endpoints.

  • Error messages:

    • "Unknown operation": Indicates the operation name was not recognized; ensure "Add iModel to My Recents" is selected.
    • API error responses will be passed through; review the message for details such as permission denied or invalid input.
    • If continueOnFail is enabled, errors will appear in the output JSON under an error field.

Links and References

Discussion