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 a specific web link associated with a component. It allows users to modify details such as the display name and URL of an existing web link tied to a component in the iTwin ecosystem.
Common scenarios where this node is beneficial include:
- Updating outdated or incorrect URLs linked to components.
- Renaming web links for clarity or rebranding purposes.
- Automating bulk updates of component web links based on external data sources.
For example, if you maintain a catalog of components and their documentation URLs, this node can be used to programmatically update those URLs when they change, ensuring all references remain current.
Properties
| Name | Meaning |
|---|---|
| Component ID | The unique identifier of the component whose web link you want to update. |
| Web Link ID | The unique identifier of the web link to update. |
| Display Name | The new display name for the web link. Must be at most 50 characters and cannot include special characters: >, <, ^, $, ?, ` |
| Uri | The new URL for the web link. |
| Options | Additional options for the request: |
| - Custom Payload | Allows overriding the default request body with a custom JSON payload. This is useful if you need to send a specially formatted request not covered by the standard properties. |
Output
The node outputs JSON objects representing the response from the iTwin Component Center API after updating the web link. The structure typically contains the updated web link information or confirmation of the update operation.
If multiple items are returned, each will be output as a separate JSON object in the array.
No binary data output is indicated.
Dependencies
- Requires an API authentication token credential for the iTwin OAuth2 API.
- The node depends on the iTwin Component Center API being accessible.
- No additional environment variables are explicitly required beyond the API credentials.
Troubleshooting
- Unknown operation error: If the operation parameter is incorrect or unsupported, the node throws an "Unknown operation" error. Ensure the operation is set exactly to "update-component-weblink".
- Invalid input errors: Providing invalid Component ID, Web Link ID, or malformed URLs/display names may cause API errors. Validate inputs before execution.
- API authentication failures: Ensure that the API key or OAuth2 token is valid and has sufficient permissions.
- Custom Payload issues: When using the custom payload option, ensure the JSON is correctly formatted; otherwise, the API request may fail.
Links and References
- iTwin Developer Documentation
- iTwin Component Center API Reference (general reference, exact endpoint docs may be found here)