iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Actions26

Overview

This node interacts with the iTwin Projects API to retrieve detailed information about a specific repository resource within an iTwin project. It is designed to fetch data related to a particular resource stored in a repository, identified by unique IDs. This functionality is useful when you need to programmatically access metadata or content of resources managed under iTwin projects, such as design files, models, or other project assets.

Practical examples include:

  • Automating retrieval of project resource details for integration with other systems.
  • Building dashboards that display repository resource information dynamically.
  • Triggering workflows based on specific resource attributes or changes.

Properties

Name Meaning
iTwin ID The unique identifier of the iTwin project containing the repository.
Repository ID The unique identifier of the repository within the iTwin project.
Resource ID The unique identifier of the specific resource within the repository to retrieve data from.

Output

The node outputs JSON data representing the retrieved repository resource's details. The structure typically includes metadata and properties associated with the resource, such as its identifiers, attributes, and possibly content references depending on the API response.

If the resource contains binary data (e.g., files), the node may provide this data in a binary format attached to the output, allowing further processing or downloading within n8n workflows.

Dependencies

  • Requires an API authentication token credential configured in n8n to authorize requests against the iTwin Projects API.
  • Depends on the ProjectsOpenApiInterpreter module internally to map operations and execute API calls.
  • Network connectivity to the Bentley iTwin API endpoints is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing iTwin ID, Repository ID, or Resource ID parameters will cause the operation to fail.
    • Authentication errors if the API key or OAuth token is not properly configured or expired.
    • Network timeouts or connectivity problems can interrupt API calls.

  • Error messages:

    • "Unknown operation: get-repository-resource" indicates the operation name might be misspelled or unsupported.
    • Errors mentioning authorization failures suggest checking the API credentials.
    • If the node returns an error object with error and nodeInfo, enabling "Continue On Fail" allows workflow continuation while logging the issue.

Links and References

Discussion