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 WebLink associated with a specific component. It is designed to facilitate adding URLs (weblinks) that reference external resources or documentation related to components managed in the iTwin ecosystem.
Common scenarios where this node is beneficial include:
- Automating the addition of reference links to components during a CI/CD pipeline.
- Enriching component metadata by linking to external documentation, issue trackers, or design resources.
- Managing and updating component-related weblinks programmatically without manual intervention.
For example, you might use this node to add a link to a component's official documentation page or a project management ticket URL directly into the component's metadata.
Properties
| Name | Meaning |
|---|---|
| Component ID | The unique identifier of the component to which the WebLink will be attached. |
| Display Name | The display name for the WebLink. It must be at most 50 characters long and cannot contain the special characters: >, <, ^, $, ?, ` |
| Uri | The URL of the WebLink. This is the actual web address that the link points to. |
| Options | Additional options for the request. Currently supports: - Custom Payload: Allows overriding the default request body with a custom JSON payload. Useful if you need to send a specialized or extended request body. |
Output
The node outputs an array of JSON objects representing the response from the iTwin Component Center API after creating the WebLink. Each output item contains the details of the created WebLink resource as returned by the API.
If the operation returns multiple items, each will be output as a separate JSON object in the array.
No binary data output is produced by this node.
Dependencies
- Requires an API authentication token credential configured in n8n to authenticate requests against the iTwin Component Center API.
- The node depends on the internal
ComponentCenterOpenApiInterpretermodule to map operations and execute API calls. - Network access to the iTwin Component Center API endpoint is necessary.
Troubleshooting
- Unknown operation error: If the node throws an error like
Unknown operation: create-component-weblink, verify that the operation name is correctly set to "Create Component WebLink" and matches the expected value. - Invalid Display Name: Ensure the display name does not exceed 50 characters and does not contain forbidden special characters (
>,<,^,$,?,||). Violations may cause API rejection. - Authentication errors: Confirm that the API key or OAuth2 credentials are valid and have sufficient permissions to create WebLinks.
- Network issues: Check connectivity to the iTwin Component Center API endpoint.
- Custom Payload JSON errors: When using the custom payload option, ensure the JSON is well-formed. Malformed JSON will cause request failures.
Links and References
- iTwin Developer Documentation
- Refer to the iTwin Component Center API docs for detailed schema and examples of WebLink creation.