iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Overview

This node interacts with the iTwin Component Center API to retrieve information about categories. Specifically, the "Get Category" operation fetches details of a single category by its unique identifier. This is useful in scenarios where you need to obtain metadata or properties related to a specific category within the iTwin ecosystem, such as organizing components or filtering data based on category attributes.

Practical examples include:

  • Fetching category details to display in a user interface.
  • Using category metadata to drive conditional logic in workflows.
  • Integrating category information into reports or dashboards.

Properties

Name Meaning
ID The unique identifier of the category to retrieve. This is a required string input specifying which category's details to fetch.

Output

The node outputs JSON data representing the category object retrieved from the iTwin Component Center API. The structure typically includes all relevant fields describing the category, such as its name, description, and any other metadata provided by the API.

If multiple items were returned (not typical for this operation), each would be output as a separate JSON object. However, since this operation targets a single category by ID, the output will be a single JSON object per execution.

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 configured in n8n for OAuth2 authentication.
  • Internet access to reach the iTwin Component Center API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing category ID: Ensure the ID provided exists and is correctly formatted.
    • Authentication errors: Verify that the API credentials are valid and have not expired.
    • Network connectivity problems: Confirm that the n8n instance can reach the iTwin API servers.
  • Error messages:

    • "Unknown operation: get-category": Indicates the operation parameter was not recognized; ensure "Get Category" is selected.
    • API errors returned from the iTwin service will be passed through; check the error message for details such as "Category not found" or permission issues.
    • If the node fails and "Continue On Fail" is disabled, the workflow will stop; enabling it allows processing subsequent items despite errors.

Links and References

Discussion