iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Overview

This node interacts with the iTwin Projects API, specifically allowing users to delete an iTwin project by its ID. It is useful in scenarios where you need to programmatically remove iTwin projects from your environment, such as cleaning up test projects, automating project lifecycle management, or integrating project deletion into larger workflows.

For example, if you have a workflow that manages multiple iTwin projects and you want to delete a specific project based on certain conditions, this node can be used to perform that deletion automatically.

Properties

Name Meaning
ID The unique identifier of the iTwin project to delete. This is a required string input representing the iTwin id.

Output

The output JSON contains the result of the delete operation. Typically, it will include confirmation of the deletion or any relevant response from the API indicating success or failure. If the operation fails and "Continue On Fail" is enabled, the output will contain an error message describing the failure.

No binary data output is expected from this node.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Projects API.
  • The node depends on the ProjectsOpenApiInterpreter module internally to handle API operations.
  • Proper configuration of the API authentication credentials within n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Invalid or missing iTwin ID: Ensure the ID provided corresponds to an existing iTwin project.
    • Authentication errors: Verify that the API key or OAuth2 credentials are correctly configured and valid.
    • Network or API availability issues: Check connectivity and API service status.
  • Error messages:

    • "Unknown operation: delete-itwin": Indicates the operation name might be incorrect or not supported; verify the operation parameter.
    • Errors returned from the API (e.g., 404 Not Found) typically mean the specified iTwin ID does not exist or is inaccessible.
    • If the node throws an error but "Continue On Fail" is enabled, the error details will appear in the output JSON under the error field.

Links and References

  • iTwin Developer Documentation
  • Refer to the official iTwin Projects API documentation for detailed information on project deletion endpoints and parameters.

Discussion