iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API
Join our community

Actions58

Overview

This node integrates with the iTwin Component Center API to retrieve information about components within a project. Specifically, the "Get Components" operation allows users to query and fetch components based on various filters such as project ID, search keywords, or associated catalogs.

Common scenarios where this node is beneficial include:

  • Retrieving all components related to a specific project for further processing or analysis.
  • Searching components by keywords in their hashtags or display names to find relevant items quickly.
  • Filtering components by catalogs to narrow down results to specific categories or collections.

Practical example:

  • A user wants to list all components tagged with certain keywords within a project to generate a report.
  • Another use case is fetching components belonging to particular catalogs to synchronize them with another system.

Properties

Name Meaning
Project ID Id of the project. Used to filter components that belong to this specific project.
Search Find all components that have the search string anywhere in the hashTags or displayName. This enables keyword-based filtering of components.
Catalogs Find all components that have the specified catalogs associated. The value should be a comma-separated list of valid catalog IDs without spaces (e.g., catalogs=abc123,def456). This filters components by catalog membership.

Output

The node outputs an array of JSON objects representing the components retrieved from the iTwin Component Center API. Each item corresponds to a component matching the query parameters.

  • The output field json contains the component data as returned by the API.
  • If multiple components are returned, each is output as a separate item in the output array.
  • If the API returns a single object, it is wrapped into one output item.
  • In case of errors (if "Continue On Fail" is enabled), the output includes an error message inside the json field.

No binary data output is produced by this node.

Dependencies

  • Requires an API authentication token credential for the iTwin OAuth2 API to authorize requests.
  • Depends on the iTwin Component Center API being accessible.
  • The node uses an internal interpreter module (ComponentCenterOpenApiInterpreter) to map operations and execute API calls.

Troubleshooting

  • Unknown operation error: If the operation parameter is set incorrectly or not supported, the node throws an error indicating "Unknown operation". Ensure the operation name matches exactly "get-components".
  • API authentication failures: Missing or invalid API credentials will cause authorization errors. Verify that the OAuth2 API key is correctly configured.
  • Empty or no results: If filters like Project ID, Search, or Catalogs do not match any components, the output will be empty. Double-check filter values for correctness.
  • Malformed Catalogs input: The catalogs property must be a comma-separated list without spaces. Spaces or invalid IDs may cause the API to reject the request.
  • When "Continue On Fail" is enabled, errors are returned as JSON objects with an error field instead of stopping execution.

Links and References

Discussion