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 document within a specified catalog. It allows users to define metadata about the document such as its display name, file extension, and purpose (e.g., thumbnail or reference). This operation is useful for managing digital assets in engineering or construction projects where organizing documents by catalogs is essential.
Typical use cases include:
- Adding new design files or references to a project catalog.
- Uploading thumbnails to visually represent catalogs.
- Automating document management workflows by programmatically creating catalog entries.
Properties
| Name | Meaning |
|---|---|
| Catalog ID | The unique identifier of the catalog where the document will be created. |
| Display Name | The display name of the document. Must be up to 250 characters and cannot contain special characters: >, <, ^, $, ?, ` |
| Extension | The file extension associated with the document, e.g., rfa, dgn, txt. |
| Purpose | The intended purpose of the document. Options are: - Thumbnail: A visual representation; only one thumbnail per catalog is allowed. - Reference: A supporting or related document. |
| Available | Boolean indicating whether a file is actually associated with this document. |
| Options | Additional options including: - Custom Payload: Allows overriding the default request body with a custom JSON payload for advanced use cases or unsupported parameters. |
Output
The node outputs an array of JSON objects representing the response from the iTwin Component Center API after creating the catalog document. Each item corresponds to a created document's details as returned by the API.
If the API returns binary data (not indicated here), it would typically represent associated files or attachments, but this node primarily handles JSON responses describing the document metadata.
Dependencies
- Requires an API key credential for authenticating with the iTwin Component Center API.
- The node depends on the
iTwinOAuth2Apicredential configured in n8n for OAuth2 authentication. - Network access to the iTwin Component Center API endpoint is necessary.
Troubleshooting
- Error: Unknown operation — This occurs if the operation parameter is incorrect or not supported. Ensure "Create Catalog Document" is selected under the Documents resource.
- Validation errors on Display Name — If the display name contains forbidden characters or exceeds length limits, the API will reject the request. Verify input constraints.
- Authentication failures — Check that the API credentials are correctly set up and have sufficient permissions.
- Catalog not found or invalid Catalog ID — Confirm the catalog ID exists and is accessible by the authenticated user.
- Multiple thumbnails error — Since only one thumbnail document is allowed per catalog, attempting to add another may cause an error. Use the Reference purpose instead if needed.