iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Overview

This node interacts with the iTwin Projects API, specifically supporting operations related to managing iTwin projects. The "Update iTwin" operation allows users to update an existing iTwin project by specifying its ID and optionally providing a custom JSON payload to override the default request body.

Common scenarios for this node include:

  • Updating metadata or configuration of an existing iTwin project.
  • Sending customized update requests when the standard parameters do not cover specific use cases.
  • Automating project updates as part of larger workflows involving iTwin infrastructure.

For example, a user might update the name or description of an iTwin project by providing the project ID and a tailored JSON payload describing the changes.

Properties

Name Meaning
ID The unique identifier of the iTwin project to update.
Options Collection of optional settings:
  Custom Payload Allows overriding the default request body with a custom JSON payload. Includes:
- Use Custom Payload (boolean): Whether to enable the custom payload override.
- JSON Payload (JSON): The actual JSON content to send as the request body when enabled.

Output

The node outputs an array of JSON objects representing the response from the iTwin Projects API after performing the update operation. Each output item contains a json field with the API response data.

If a custom payload is used, the output reflects the API's response to that payload.

No binary data output is produced by this node.

Dependencies

  • Requires an API authentication credential configured in n8n to access the iTwin Projects API.
  • Depends on the internal ProjectsOpenApiInterpreter module to map and execute API operations.
  • The node expects network connectivity to the Bentley iTwin API endpoints.

Troubleshooting

  • Unknown operation error: If the specified operation is not recognized, ensure the operation name matches exactly ("update-itwin" in this case).
  • API authentication failures: Verify that the API key or OAuth2 credentials are correctly set up and have sufficient permissions.
  • Invalid JSON payload: When using the custom payload option, ensure the JSON is well-formed; otherwise, the API may reject the request.
  • Missing required ID: The iTwin ID must be provided; omitting it will cause the node to fail.
  • Continue on Fail behavior: If enabled, errors during execution will be captured in the output rather than stopping the workflow.

Links and References

Discussion