iTwin Projects icon

iTwin Projects

Consume the iTwin Projects API

Actions5

Overview

This node interacts with the iTwin Projects API to manage projects within the iTwin platform. It supports operations such as creating, deleting, retrieving, listing, and updating projects. The "Delete" operation specifically allows users to remove a project by its unique identifier.

Common scenarios for this node include automating project lifecycle management in infrastructure or engineering workflows, integrating project data with other systems, or cleaning up obsolete projects programmatically.

For example, a user might use this node to delete a project after its completion to maintain an organized project repository or to automate cleanup tasks in batch processes.

Properties

Name Meaning
Project ID The unique identifier of the project to delete

Output

The output JSON contains a single field indicating the success of the deletion operation:

{
  "success": true
}

This confirms that the specified project was successfully deleted. There is no binary data output from this operation.

Dependencies

  • Requires an API authentication token credential to access the iTwin Projects API.
  • The node depends on the iTwin API endpoint for project management.
  • Proper network connectivity to the iTwin API service is necessary.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Project ID will likely result in an error from the API.
    • Insufficient permissions or expired API credentials can cause authorization failures.
    • Network connectivity problems may prevent successful API calls.
  • Error messages and resolutions:

    • "Project not found" — Verify the Project ID is correct and exists.
    • "Unauthorized" or "Authentication failed" — Check that the API key or token is valid and has the necessary permissions.
    • Timeout or network errors — Ensure stable internet connection and that the iTwin API service is reachable.

Links and References

Discussion