iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Overview

This node operation retrieves the list of iTwins (digital twins) that the authenticated user has recently used. It allows filtering the results by specifying subclasses, status, type, or whether to include inactive iTwins. This is useful for workflows that need to quickly access or process the user's recent iTwin projects without manually searching or querying all available iTwins.

Practical examples:

  • Automatically fetching recently accessed iTwins to display in a dashboard.
  • Triggering follow-up actions on recently used iTwins, such as syncing data or generating reports.
  • Filtering recent iTwins by specific categories (subclasses) or statuses to focus on relevant projects.

Properties

Name Meaning
Sub Class Specify one or more iTwin subclasses to filter the query. Using subclasses speeds up queries and narrows results. Multiple subclasses can be specified as a comma-separated string (e.g., "Asset,Project"). See iTwin subclasses.
Status Filter iTwins by a particular status. Cannot be used simultaneously with Include Inactive.
Type Filter iTwins by a particular type.
Include Inactive Boolean flag to include inactive iTwins in the results. By default, inactive iTwins are excluded. Cannot be used at the same time as the Status parameter.

Output

The output is an array of JSON objects representing the recently used iTwins matching the query criteria. Each item contains details about an iTwin, such as its identifier, name, status, type, subclass, and other metadata as provided by the API.

If the node supports binary data output, it is not indicated in the provided code or properties, so the output is purely JSON-based.

Dependencies

  • Requires an API authentication token credential to access the iTwin platform.
  • Depends on the iTwin Projects API to fetch recent iTwin data.
  • The node uses an internal interpreter module (ProjectsOpenApiInterpreter) to execute the API operations.

Troubleshooting

  • Common issues:

    • Providing both status and includeInactive parameters simultaneously will likely cause an error because they are mutually exclusive.
    • Incorrect subclass or type strings may result in empty results or API errors.
    • Missing or invalid API credentials will prevent successful API calls.
  • Error messages:

    • "Unknown operation: <operation>": Indicates the requested operation is not supported by the node; ensure the operation name is correct.
    • API errors related to authentication or permissions should be resolved by verifying the API key or OAuth token configuration.
    • Network or timeout errors may require checking connectivity or retrying later.

Links and References

Discussion