iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Overview

This node integrates with the iTwin Component Center API to create a new category. It allows users to define a category by specifying its display name, which is useful for organizing components or items within the iTwin ecosystem. Typical use cases include automating the categorization of components in design workflows or managing component libraries programmatically.

For example, a user might automate the creation of categories like "Structural Elements" or "Electrical Components" to better organize their digital assets.

Properties

Name Meaning
Display Name The display name of the category to be created. Must be a string up to 250 characters and cannot include special characters: >, <, ^, $, ?, ||.
Options Additional options for the request.
   Use Custom Payload Boolean flag to override the default request body with a custom JSON payload.
   JSON Payload When enabled, this JSON object will be sent as the request body instead of the standard parameters.

Output

The node outputs an array of JSON objects representing the response from the iTwin Component Center API after creating the category. Each output item contains the full JSON response body returned by the API, which typically includes details about the newly created category such as its ID, display name, and other metadata.

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

  • Invalid Display Name: If the display name contains forbidden special characters or exceeds 250 characters, the API may reject the request. Ensure the input meets the validation rules.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the OAuth2 credentials are correctly set up.
  • Unknown Operation Error: If the operation parameter is incorrect or missing, the node throws an error indicating an unknown operation.
  • Custom Payload Issues: When using a custom JSON payload, ensure it is valid JSON and matches the API's expected schema to avoid request errors.

Links and References

Discussion