iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Overview

This node is designed to delete a specific resource from a repository within an iTwin project environment. It is useful in scenarios where you need to programmatically manage and clean up resources stored in repositories, such as removing outdated or unnecessary files or data entries. For example, if you have automated workflows that manage digital twin data and want to remove certain resources when they are no longer needed, this node can be integrated to perform those deletions efficiently.

Properties

Name Meaning
iTwin ID The unique identifier of the iTwin project where the repository exists.
Repository ID The unique identifier of the repository containing the resource.
Resource ID The unique identifier of the resource to be deleted from the repository.

Output

The output of the node is a JSON object representing the result of the delete operation. Typically, this will confirm whether the deletion was successful or provide details about the operation's outcome. If the operation returns multiple results (unlikely for a delete), each would be output as separate JSON objects. There is no indication that binary data is involved in this operation.

Dependencies

  • Requires an API authentication token credential to access the iTwin Projects API.
  • Depends on the ProjectsOpenApiInterpreter module to interpret and execute the delete operation.
  • The node expects proper configuration of credentials and network access to the iTwin platform's API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing iTwin ID, Repository ID, or Resource ID parameters will cause the operation to fail.
    • Authentication failures due to incorrect or expired API tokens.
    • Network connectivity problems preventing access to the iTwin API.
    • Attempting to delete a resource that does not exist or has already been deleted.
  • Error messages:

    • "Unknown operation: delete-repository-resource": This indicates the operation name might be misspelled or not supported; ensure the correct operation is selected.
    • Errors related to authorization typically suggest checking the API key or OAuth token validity.
    • If the node throws an error with a message including "execution failed," enabling "Continue On Fail" can help capture errors without stopping the workflow.

Links and References

Discussion