iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Actions26

Overview

This node interacts with the iTwin Projects API to retrieve graphics associated with a specific resource within an iTwin project. It is designed to fetch graphical data tied to a particular resource identified by its IDs. This functionality is useful in scenarios where users need to programmatically access visual representations or metadata of resources managed within iTwin projects, such as retrieving architectural drawings, engineering models, or other graphical assets linked to a project.

Practical examples include:

  • Automatically fetching updated graphics for a resource when changes occur.
  • Integrating resource graphics into custom dashboards or reporting tools.
  • Archiving or processing graphical data from iTwin projects for further analysis.

Properties

Name Meaning
iTwin ID The unique identifier of the iTwin project containing the resource.
Repository ID The identifier of the repository where the resource is stored.
Resource ID The unique identifier of the specific resource whose graphics are to be retrieved.

Output

The node outputs JSON data representing the graphics associated with the specified resource. The exact structure depends on the API response but typically includes graphical metadata and possibly encoded graphic content or references to graphic files.

If the node supports binary data output (not explicitly shown in the code), it would represent the actual graphical files or images related to the resource.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Projects API.
  • Needs proper configuration of the iTwin OAuth2 authentication within n8n to authorize API requests.
  • Depends on the ProjectsOpenApiInterpreter module to interpret and execute API operations.

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 OAuth2 credentials are not correctly configured.
    • Network or API endpoint issues may result in request failures.

  • Error messages:

    • "Unknown operation: get-resource-graphics" indicates that the operation name is incorrect or not supported.
    • Errors related to missing parameters will typically mention which required field is absent.
    • Authentication errors will prompt checking the API credentials setup.

To resolve these issues:

  • Verify all required input properties are provided and correctly formatted.
  • Ensure the API credentials are valid and have necessary permissions.
  • Check network connectivity and API endpoint availability.

Links and References

Discussion