iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Actions26

Overview

This node operation updates a repository within an iTwin project by sending an API request to modify the repository's details. It is useful when you need to programmatically change repository information such as metadata or configuration in an iTwin environment.

Typical use cases include:

  • Automating repository updates as part of a CI/CD pipeline.
  • Synchronizing repository data with external systems.
  • Customizing repository settings based on dynamic inputs.

Properties

Name Meaning
iTwin ID The unique identifier of the iTwin project that contains the repository to update.
Repository ID The unique identifier of the repository to be updated within the specified iTwin project.
Options Additional optional parameters for the update operation:
- Custom Payload Allows overriding the default request body with a custom JSON payload for the API call.

The Custom Payload option includes:

  • Use Custom Payload (boolean): Whether to replace the standard request body with your own JSON.
  • JSON Payload (JSON): The custom JSON object to send as the request body if enabled.

Output

The node outputs the response from the API call in the json field of each item. This typically contains the updated repository data or confirmation of the update operation.

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 token credential configured in n8n to authorize requests to the iTwin Projects API.
  • Depends on the internal ProjectsOpenApiInterpreter module to map and execute the API operations.
  • Network access to the iTwin Projects API endpoint is necessary.

Troubleshooting

  • Unknown operation error: If the operation parameter is incorrect or unsupported, the node will throw an "Unknown operation" error. Ensure the operation name matches exactly "update-itwin-repository".
  • API authentication failures: Missing or invalid API credentials will cause authorization errors. Verify that the API key or OAuth2 token is correctly set up.
  • Invalid JSON payload: When using the custom payload option, malformed JSON will cause parsing errors. Validate JSON syntax before enabling this option.
  • Repository or iTwin ID not found: Providing incorrect IDs will result in API errors indicating resource not found. Double-check the IDs are correct and exist in the target environment.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Discussion