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 updates a specific WebLink within a catalog in the iTwin Component Center. It is useful when you need to modify metadata or URLs associated with existing WebLinks in your component catalogs, such as correcting URLs, updating display names, or changing link targets.
Practical examples:
- Updating the URL of a documentation link after it has moved.
- Changing the display name of a WebLink to better reflect its content.
- Overriding the default request payload to send custom data for advanced API scenarios.
Properties
| Name | Meaning |
|---|---|
| Catalog ID | The unique identifier of the catalog containing the WebLink to update. |
| Web Link ID | The unique identifier of the WebLink that you want to update. |
| Display Name | The new display name for the WebLink. Must be at most 50 characters and cannot include special characters >, <, ^, $, ?, or ` |
| Uri | The new URL for the WebLink. |
| Options | Additional optional settings: - Custom Payload: Allows overriding the request body with a custom JSON payload instead of the standard fields. Useful for sending specialized or non-standard API requests. |
Output
The node outputs an array of JSON objects representing the updated WebLink(s). Each output item contains the response from the API after the update operation, typically including the updated WebLink details.
If a custom payload is used, the output corresponds to the API's response to that payload.
No binary data output is produced by this node.
Dependencies
- Requires an API authentication token credential configured in n8n to access the iTwin Component Center API.
- The node depends on the internal
ComponentCenterOpenApiInterpretermodule to map operations and execute API calls. - Network connectivity to the iTwin Component Center API endpoint is necessary.
Troubleshooting
Common issues:
- Invalid or missing Catalog ID or Web Link ID will cause the API call to fail.
- Display Name exceeding 50 characters or containing forbidden special characters will likely result in validation errors.
- Incorrectly formatted URI may cause the API to reject the update.
- Using a malformed custom JSON payload can lead to parsing errors or unexpected API responses.
Error messages:
"Unknown operation: update-catalog-weblink": Indicates the operation name is not recognized; ensure the operation parameter is correctly set.- API errors related to authorization usually mean the API key or token is invalid or expired.
- Validation errors from the API about field formats should be resolved by adhering to the property constraints described above.
Resolution tips:
- Double-check all required IDs and strings for correctness.
- Validate JSON syntax if using the custom payload option.
- Ensure the API credentials are valid and have sufficient permissions.
Links and References
- iTwin Component Center API Documentation
- n8n Documentation on Creating Custom Nodes (for general understanding)