iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Overview

This node operation allows users to add a specific iTwin project (identified by its ID) to their list of favorites. It is useful for workflows where users want to quickly bookmark or mark certain iTwin projects as favorites for easier access or further processing. For example, automating the addition of frequently accessed iTwins to a user's favorites list after certain triggers or events.

Properties

Name Meaning
ID The unique identifier of the iTwin project to be added to the favorites 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 payload.

Output

The output consists of JSON data representing the result of the "add to favorites" operation. This typically includes confirmation details or the updated favorite status of the specified iTwin. The exact structure depends on the API response but generally confirms success or failure.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential to authorize requests to the iTwin Projects API.
  • Uses the iTwin Projects API endpoint to perform the "add to favorites" action.
  • No additional external dependencies are indicated beyond the bundled interpreter module for API operations.

Troubleshooting

  • Common issues:

    • Providing an invalid or empty iTwin ID will likely cause the operation to fail.
    • Network or authentication errors if the API key/token is missing, expired, or incorrect.
    • Malformed custom JSON payloads when using the "Custom Payload" option can cause request failures.
  • Error messages:

    • "Unknown operation": Indicates the operation name was not recognized; ensure "Add iTwin to my favorites" is selected.
    • API errors returned from the iTwin service will be passed through; check the error message for details.
  • Resolutions:

    • Verify the iTwin ID is correct and exists.
    • Ensure valid API credentials are configured in n8n.
    • Validate any custom JSON payload before enabling the override option.

Links and References

Discussion