Overview
This node interacts with the iTwin Projects API to manage project entities within the iTwin platform. It supports creating, deleting, retrieving, listing, and updating projects. The "Create" operation specifically allows users to create a new project by specifying its display name, an optional unique project number, and additional optional fields such as location, status, time zone, and type.
Typical use cases include automating project setup workflows, integrating project creation into larger automation pipelines, or managing projects programmatically without using the iTwin web interface.
For example, you could use this node to automatically create a new project in response to a form submission or trigger from another system, setting key metadata like geographic location and status at creation time.
Properties
| Name | Meaning |
|---|---|
| Display Name | The display name for the new project (required). |
| Project Number | An optional unique identifier string for the project. |
| Additional Fields | A collection of optional fields: |
| - Data Center Location | Specifies the data center location for the project. |
| - Geographical Location | Geographic location of the project. |
| - Status | Status of the project; options are Active, Inactive, or Trial. |
| - Time Zone | Time zone associated with the project. |
| - Type | Type/category of the project. |
Output
The output is a JSON object representing the created project entity returned by the iTwin Projects API. This includes all properties of the project such as its ID, display name, number, status, locations, and other metadata.
The output structure corresponds to the iTwin property of the API response, which contains the full details of the newly created project.
No binary data output is produced by this operation.
Dependencies
- Requires an API authentication token credential configured in n8n to access the iTwin Projects API.
- The node uses the iTwin OAuth2 authentication mechanism to authorize requests.
- Network connectivity to the iTwin API endpoint is necessary.
Troubleshooting
Common issues:
- Missing or invalid API credentials will cause authentication failures.
- Providing invalid or incomplete required fields (e.g., missing Display Name) will result in validation errors from the API.
- Network issues or API downtime can cause request failures.
Error messages:
- Authentication errors typically indicate problems with the OAuth2 token or credential configuration.
- Validation errors from the API will specify which fields are missing or invalid.
- Timeout or network errors suggest connectivity problems.
Resolutions:
- Ensure the API credential is correctly set up and authorized.
- Verify all required fields are provided and valid.
- Check network connectivity and retry if transient errors occur.
Links and References
- iTwin Developer Documentation
- iTwin Projects API Reference (for detailed API schema and capabilities)