iTwin Issues icon

iTwin Issues

iTwin Issues API for issue management, form definitions, attachments, and comments

Actions27

Overview

This node operation allows uploading a file to update a specific list group within an iTwin project. It is useful when you need to programmatically update or replace the contents of a list group by sending a file payload to the backend service managing iTwin data.

Typical use cases include:

  • Automating bulk updates to list groups in an iTwin project.
  • Integrating external data sources by uploading files directly into list groups.
  • Managing list group content as part of a larger workflow involving iTwin data synchronization.

For example, you might have a CSV or JSON file representing updated group members or attributes that you want to upload to a particular list group identified by its ID within a given iTwin.

Properties

Name Meaning
iTwin ID The unique identifier of the iTwin project that owns the list group to be updated.
ID The unique identifier of the list group to which the file will be uploaded.
Options Additional optional settings:
- Custom Payload (enabled) Boolean flag to override the default request body with a custom JSON payload.
- Custom Payload (payload) The actual JSON payload to send if the custom payload option is enabled.

Output

The node outputs JSON data representing the response from the API after uploading the file to the specified list group. This typically includes confirmation of the upload status, any metadata about the updated list group, or error information if the upload failed.

If binary data is involved (e.g., the file content), it would be handled internally and not exposed directly in the output JSON; instead, the output focuses on the API response confirming the upload.

Dependencies

  • Requires an API key credential for authenticating requests to the iTwin platform's API.
  • The node depends on an internal utility function to execute the API request.
  • Network access to the Bentley iTwin API endpoint is necessary.
  • No additional environment variables are explicitly required beyond standard n8n credential configuration.

Troubleshooting

  • Common issues:

    • Invalid or missing iTwin ID or list group ID will cause the API call to fail.
    • Incorrectly formatted custom JSON payloads can lead to request errors.
    • Network connectivity problems or expired API credentials will prevent successful uploads.

  • Error messages:

    • "Unsupported operation" indicates the node was configured with an invalid operation name.
    • API errors returned from the server will be included in the output JSON under an error property.
    • If the node fails and "Continue On Fail" is disabled, execution will stop immediately; enabling this option allows processing subsequent items despite errors.

  • Resolutions:

    • Verify all required IDs are correct and exist in the iTwin system.
    • Validate JSON syntax when using the custom payload option.
    • Ensure API credentials are valid and have sufficient permissions.
    • Check network connectivity and retry if transient errors occur.

Links and References

Discussion