iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Overview

This node interacts with the iTwin Component Center API to retrieve categories of components. Specifically, the "Get Categories" operation fetches a paginated list of component categories available in the Component Center. It is useful when you want to programmatically explore or filter components by their categories within an automation workflow.

A common scenario includes fetching all categories to display them for user selection or to use category filters in subsequent API calls. For example, you might use this node to get the first 50 categories and then use the continuation token to fetch additional pages if more categories exist.

Properties

Name Meaning
Continuation Token A string token used for pagination. The API returns up to 50 results per request along with a continuation token for the next page. Provide this token to fetch the next set of results. If no token is provided, the first page is fetched.

Output

The output is a JSON array where each item represents a category object retrieved from the Component Center API. Each JSON object contains details about a single category.

If multiple categories are returned, they appear as separate JSON objects in the output array.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Component Center API.
  • The node depends on the iTwinOAuth2Api credential (an OAuth2-based authentication) configured in n8n.
  • Internet access to reach the iTwin Component Center API endpoints.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing an incorrect or expired continuation token may result in errors or empty responses.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • "Unknown operation: get-categories": This indicates the operation parameter was not recognized; ensure the operation name is exactly "get-categories".
    • API errors related to authentication or rate limits will be passed through; check your API key validity and usage quotas.
    • If the node fails but "Continue On Fail" is enabled, error details will be included in the output JSON under an error field.

Links and References

Discussion