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 catalog. It allows users to define catalogs by specifying details such as display name, description, region, and hashtags. This is useful for organizing components or documents within the iTwin ecosystem, enabling structured management and retrieval.
Typical use cases include:
- Automating the creation of component catalogs in an engineering or construction project.
- Organizing digital assets or documents into categorized catalogs for easier access.
- Integrating catalog creation into larger workflows that manage iTwin components programmatically.
Properties
| Name | Meaning |
|---|---|
| Display Name | The display name of the catalog document. Must be unique, up to 250 characters, and cannot contain special characters: >, <, ^, $, ?, ` |
| Description | A textual description of the catalog, up to 250 characters. |
| Region | The geographical or logical region associated with the catalog, up to 250 characters. |
| Hashtags | A JSON array of hashtags related to the catalog. Each hashtag can be up to 50 characters and must not include special characters: >, <, ^, $, ?, ` |
| Options | Additional options including: - Custom Payload: Allows overriding the default request body with a custom JSON payload. Useful for advanced users who want to send specific data structures directly to the API. |
Output
The node outputs JSON objects representing the created catalog(s). The output structure corresponds to the response from the iTwin Component Center API after creating a catalog. Typically, this includes details about the newly created catalog such as its ID, display name, description, region, hashtags, and other metadata returned by the API.
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
iTwinOAuth2Apicredential (or equivalent) configured in n8n to authorize requests. - Internet connectivity to reach the iTwin Component Center API endpoint.
- The node uses an internal interpreter module (
ComponentCenterOpenApiInterpreter) to map operations and execute API calls.
Troubleshooting
- Invalid Display Name or Hashtags: If the display name or hashtags contain forbidden special characters or exceed length limits, the API may reject the request. Ensure inputs conform to the specified constraints.
- Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key or OAuth token is correctly configured and has necessary permissions.
- Unknown Operation Error: If the operation parameter is incorrect or unsupported, the node throws an "Unknown operation" error. Confirm that the operation is set to "create-catalog".
- Malformed Custom Payload: When using the custom payload option, ensure the JSON is valid and matches the expected API schema; otherwise, the API may return errors.
- Network Issues: Connectivity problems can cause timeouts or failed requests. Check network settings and API availability.
Links and References
- iTwin Component Center API Documentation
- n8n Documentation on Creating Custom Nodes