iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Actions26

Overview

This node interacts with the iTwin platform to manage images associated with iTwins. Specifically, the "Delete iTwin Image" operation allows users to delete an image linked to a particular iTwin ID. This is useful in scenarios where images need to be removed from an iTwin project for cleanup, updates, or access control purposes.

Practical examples include:

  • Removing outdated or incorrect images from an iTwin project.
  • Automating cleanup of images when an iTwin project is archived or deleted.
  • Managing image lifecycle as part of a larger iTwin project automation workflow.

Properties

Name Meaning
iTwin ID The unique identifier of the iTwin associated with the image to be deleted.

Output

The output of this node is a JSON object indicating the result of the delete operation. It typically contains either confirmation of successful deletion or error information if the operation failed.

Example output structure:

{
  "result": "success"
}

or in case of failure:

{
  "error": "Error message describing what went wrong",
  "nodeInfo": "iTwin Projects execution failed"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API authentication token credential to connect securely to the iTwin platform.
  • Depends on the iTwin Projects API to perform operations related to iTwin images.
  • The node uses an internal interpreter module to map and execute the specific API operation.

Troubleshooting

  • Common issues:

    • Invalid or missing iTwin ID parameter will cause the operation to fail.
    • Authentication errors if the API key or OAuth token is invalid or expired.
    • Network connectivity problems can prevent communication with the iTwin API.

  • Error messages:

    • "Unknown operation: delete-itwin-image" indicates the operation name was not recognized; ensure the correct operation is selected.
    • Errors returned from the API will be included in the output under the error field.

  • Resolution tips:

    • Verify that the iTwin ID is correctly provided and corresponds to an existing iTwin.
    • Ensure valid and active API credentials are configured in n8n.
    • Check network connectivity and API endpoint availability.

Links and References

Discussion