Actions58
- Applications Actions
- Components Actions
- Brands Actions
- Documents Actions
- Weblinks Actions
- Manufacturers Actions
- Catalogs Actions
- Download Actions
- Variations Actions
- Categories Actions
- Upload Actions
- Jobs Actions
Overview
This node integrates with the iTwin Component Center API to create a new component variation. It allows users to define variations of components by specifying details such as the component ID, display name, associated design document, and additional custom properties. This is useful in scenarios where different versions or configurations of a component need to be managed programmatically, for example, in digital twin applications or design systems where components evolve over time.
Practical examples include:
- Creating a new variation of a building component with specific design attributes.
- Managing multiple design iterations of a mechanical part within a digital twin environment.
- Automating the creation of component variations based on external data sources or workflows.
Properties
| Name | Meaning |
|---|---|
| Component ID | The unique identifier of the component for which the variation is being created. |
| Display Name | The display name of the variation. Must be up to 250 characters and cannot include special characters: >, <, ^, $, ?, ` |
| Associated Design Document | The ID of the design document associated with this variation. |
| Ad Hoc Properties | A JSON array representing a list of additional custom properties for the variation. |
| Options | Collection of optional settings, including: - Custom Payload: Allows overriding the request body with a custom JSON payload if enabled. This can be used to send any specific data structure directly to the API. |
Output
The node outputs an array of JSON objects representing the response from the iTwin Component Center API after creating the component variation. Each item corresponds to the created variation's details as returned by the API.
If a custom payload is used, the output reflects the API's response to that payload.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the iTwin Component Center API.
- The node depends on the
iTwinOAuth2Apicredential (an OAuth2-based authentication token) configured in n8n. - Internet access to the iTwin Component Center API endpoint.
- The node uses an internal interpreter module (
ComponentCenterOpenApiInterpreter) to map operations and execute API calls.
Troubleshooting
Common issues:
- Invalid or missing Component ID or Display Name will cause the API call to fail.
- Special characters in the Display Name may result in validation errors.
- Incorrectly formatted JSON in Ad Hoc Properties or Custom Payload can cause parsing errors.
- Authentication failures due to invalid or expired API tokens.
Error messages:
"Unknown operation: ..."indicates the specified operation is not supported; verify the operation name.- API errors returned from the iTwin service will be included in the node's error output if "Continue On Fail" is enabled.
- JSON parsing errors when using custom payloads usually mean the JSON syntax is incorrect; validate the JSON before use.
Links and References
- iTwin Developer Documentation
- n8n Documentation on Credentials
- JSON Validation Tools (for validating custom JSON payloads)