iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Overview

This node operation "Add iTwin to my recents" allows users to add a specific iTwin project identified by its ID to their list of recent iTwins. This is useful for quickly accessing frequently used or recently worked-on iTwins without searching for them again. For example, after opening or modifying an iTwin project, you can use this operation to update your recents list so that it appears prominently in your workspace or application interface.

Properties

Name Meaning
ID The unique identifier of the iTwin project to add to the recents list.
Options Collection of optional settings:
  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 output consists of JSON data representing the result of the API call to add the iTwin to the recents list. The exact structure depends on the API response but generally includes confirmation of the addition or details about the updated recents. No binary data output is indicated.

Dependencies

  • Requires an API authentication token (OAuth2 or similar) configured in n8n to authorize requests to the iTwin Projects API.
  • Depends on the iTwin Projects API endpoint that manages user recents.
  • The node internally uses an interpreter module (ProjectsOpenApiInterpreter) to map operations and execute API calls.

Troubleshooting

  • Common issues:
    • Invalid or missing iTwin ID: Ensure the ID is correctly specified and corresponds to an existing iTwin.
    • Authentication errors: Verify that the API credentials are valid and have sufficient permissions.
    • API connectivity problems: Check network access and API availability.
  • Error messages:
    • "Unknown operation": Indicates the operation name was not recognized; ensure "add-itwin-to-my-recents" is correctly set.
    • API error responses will be passed through; check the message for details such as permission denied or invalid input.
  • To resolve errors, confirm all required parameters are set, credentials are correct, and the API service is reachable.

Links and References

  • iTwin Developer Documentation
  • Refer to the official iTwin Projects API docs for detailed information on managing recents and other project operations.

Discussion