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 within a specified catalog. It is designed to facilitate adding URLs (WebLinks) that reference external resources or documentation related to components in a catalog.
Common scenarios where this node is beneficial include:
- Automating the addition of reference links to component catalogs during CI/CD pipelines.
- Enriching component metadata by linking to external documentation, design specs, or related resources.
- Managing and updating catalogs programmatically without manual UI interaction.
For example, you can use this node to add a link to a product's online documentation or a related GitHub repository directly into your component catalog.
Properties
| Name | Meaning |
|---|---|
| Catalog ID | The unique identifier of the catalog where the WebLink will be created. This is required to specify the target catalog. |
| Display Name | The display name for the WebLink. It must be a string up to 50 characters long and cannot contain special characters: >, <, ^, $, ?, ` |
| Uri | The URL of the WebLink. This should be a valid web address pointing to the resource you want to link to. |
| Options | Additional optional settings: |
| Custom Payload | Allows overriding the default request body with a custom JSON payload. Enable this option to send a fully customized JSON object instead of the standard parameters. Useful for advanced use cases or API changes. |
Output
The node outputs JSON data representing the response from the iTwin Component Center API after creating the WebLink. The structure typically includes details about the newly created WebLink such as its ID, display name, URI, and any other metadata returned by the API.
If a custom payload is used, the output corresponds to whatever the API returns based on that payload.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the iTwin Component Center API.
- The node depends on the iTwin Component Center API being accessible and properly configured.
- Network connectivity to the API endpoint is necessary.
- No additional environment variables are explicitly required beyond the API authentication setup.
Troubleshooting
- Invalid Catalog ID: If the provided catalog ID does not exist or is incorrect, the API will return an error. Verify the catalog ID before running the node.
- Display Name Validation: Using disallowed special characters or exceeding the 50-character limit in the display name will cause validation errors. Ensure the display name meets the criteria.
- URI Format Issues: Providing an invalid URL format may result in API rejection. Confirm the URI is a well-formed URL.
- Authentication Failures: Missing or invalid API credentials will prevent the node from executing successfully. Check that the API key or token is correctly configured.
- Custom Payload Errors: When using the custom payload option, malformed JSON or incorrect API fields can cause failures. Validate the JSON syntax and API schema compliance.
- Network Issues: Timeouts or connectivity problems can cause execution failures. Ensure stable network access to the API endpoint.
Links and References
- iTwin Component Center API Documentation
- n8n Documentation - Creating Custom Nodes
- JSON Schema Validator (useful for validating custom payloads)