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 catalog document. It allows users to modify metadata of an existing document within a specified catalog, such as changing its display name, file extension, purpose, and availability status.
Common scenarios where this node is beneficial include:
- Updating document details after revisions or corrections.
- Changing the role of a document in a catalog (e.g., switching between thumbnail and reference).
- Managing document metadata programmatically as part of automated workflows.
Practical example:
- A user wants to update the display name and mark a document as available after uploading a new version to the catalog.
Properties
| Name | Meaning |
|---|---|
| Catalog ID | The unique identifier of the catalog containing the document to update. |
| Document ID | The unique identifier of the document to be updated. |
| Display Name | The new display name for the document. Must be up to 250 characters and cannot include 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 (only one per catalog) or Reference. |
| Available | Boolean indicating whether a file is currently associated with the document. |
| Options | Additional options including the ability to provide a custom JSON payload to override the default request body. |
Output
The node outputs an array of JSON objects representing the response from the iTwin Component Center API after updating the document. Each output item corresponds to the updated document data returned by the API.
If a custom payload is used, the output reflects the API's response to that payload.
No binary data output is indicated.
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
Common issues:
- Invalid or missing Catalog ID or Document ID will cause the update to fail.
- Providing a display name with forbidden special characters or exceeding length limits will result in validation errors.
- Attempting to set more than one document as a thumbnail in the same catalog may be rejected by the API.
- Incorrect or expired API credentials will cause authentication failures.
Error messages:
"Unknown operation": Indicates the operation parameter was not recognized; ensure "update-catalog-document" is selected.- API error responses related to invalid input fields should be checked against property constraints.
- Network or authentication errors require verifying API credentials and connectivity.
Links and References
- iTwin Developer Documentation
- Refer to the iTwin Component Center API docs for detailed information on document update endpoints and payload structure.