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 update an existing category by its ID. It allows users to modify the display name of a category, which is useful for organizing and managing components within the iTwin ecosystem. Typical use cases include renaming categories to better reflect their contents or correcting naming errors.
For example, if you have a category named "Structural Elements" but want to rename it to "Structural Components," this node can perform that update programmatically.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the category to update. This is required to specify which category will be modified. |
| Display Name | The new display name for the category. It must be a string up to 250 characters and cannot include special characters such as >, <, ^, $, ?, or ` |
| Options | Additional options including: - Custom Payload: Allows overriding the default request body with a custom JSON payload. Useful when you need to send a specific structure not covered by the standard fields. |
Output
The node outputs the response from the iTwin Component Center API after updating the category. The output is structured as JSON and typically contains the updated category details or confirmation of the update operation.
If a custom payload is used, the output reflects the API's response to that payload.
Dependencies
- Requires an API key credential for authenticating with the iTwin Component Center API.
- The node depends on the
ComponentCenterOpenApiInterpreterclass internally to map operations and execute API calls. - Proper configuration of the API credentials in n8n is necessary for successful execution.
Troubleshooting
- Invalid ID: If the provided category ID does not exist, the API will return an error indicating the category was not found. Verify the ID before running the node.
- Invalid Display Name: Using disallowed special characters or exceeding the length limit in the display name will cause validation errors. Ensure the display name meets the specified constraints.
- Authentication Errors: Missing or incorrect API credentials will result in authentication failures. Confirm that the API key or token is correctly configured.
- Custom Payload Issues: When using the custom payload option, ensure the JSON is well-formed and matches the API's expected schema to avoid request errors.
Links and References
- iTwin Developer Documentation
- iTwin Component Center API Reference (general link; specific endpoint docs may be found here)