iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Actions26

Overview

This node operation creates an export of iTwin data based on specified criteria. It allows users to define the scope of the query, filter and select specific iTwin subclasses and properties, and choose the output format for the exported data. This is useful for scenarios where you need to extract subsets of iTwin information for reporting, backup, analysis, or integration with other systems.

Practical examples include:

  • Exporting all active Assets and Projects that a user is a member of.
  • Generating a CSV report of specific iTwin properties filtered by status or creation date.
  • Creating compressed JSON exports for archival or transfer purposes.

Properties

Name Meaning
Query Scope The scope of the query determining whether to export iTwins the user is a member of ("Member Ofi Twin") or all iTwins in the organization ("Organization Admin"). Only administrators can use the organization-wide option.
Sub Class One or more iTwin subClasses to include in the export, specified as a comma-delimited list (e.g., "Asset,Project"). If omitted, all subClasses are included.
Select Comma-delimited list of iTwin properties to include in the export. Keeping this list small improves export speed and reduces file size. Defaults to minimal representation including id, class, subClass, type, number, displayName if empty.
Filter An OData filter string to further limit which iTwins are exported. Supports logical operators and functions like in, eq, contains, startswith. Text values are case insensitive. Examples provided in the description.
Include Inactive Boolean flag indicating whether to include inactive iTwins in the export. By default, inactive iTwins are excluded. Cannot be used together with a status filter in the Filter property.
Output Format The format of the export file. Options include: Json G Zip, Json Zip Archive, Csv G Zip, and Csv.
Options Additional options including a "Custom Payload" feature that allows overriding the request body with a custom JSON payload. Useful for advanced or unsupported API requests.

Output

The node outputs the result of the export operation in the json field of the output data. The exact structure depends on the chosen output format but generally includes the exported iTwin data in the requested format (JSON or CSV), optionally compressed (GZip or Zip archive).

If binary data is returned (e.g., compressed files), it will represent the export file content suitable for saving or further processing.

Dependencies

  • Requires an authenticated connection to the iTwin platform API using an appropriate API key or OAuth2 token.
  • The node expects network access to the iTwin services.
  • No additional external dependencies beyond standard n8n credentials and HTTP request capabilities.

Troubleshooting

  • Error when using both Include Inactive and a status filter: The API does not allow combining these two filters. Remove one to resolve the conflict.
  • Invalid filter syntax: Ensure the OData filter string is correctly formatted and uses supported operators and functions.
  • Permission errors when using "Organization Admin" scope: Verify that the API credentials belong to an administrator with the required permissions.
  • Large export files or slow performance: Reduce the number of selected properties or narrow the filter criteria to limit the data volume.
  • Custom Payload issues: When using the custom payload option, ensure the JSON is valid and matches the expected API schema.

Links and References

Discussion