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 retrieve documents associated with a specific catalog. The "Get Catalog Documents" operation fetches all documents linked to a given catalog ID. This is useful in scenarios where users need to programmatically access or manage component documentation stored within the iTwin ecosystem, such as for automation of documentation retrieval, integration with other systems, or bulk processing of component data.
Practical examples include:
- Automatically fetching all documents related to a catalog for auditing or reporting.
- Integrating catalog document data into a content management system.
- Triggering workflows based on the presence or updates of catalog documents.
Properties
| Name | Meaning |
|---|---|
| Catalog ID | Id of the catalog to retrieve documents from. |
Output
The node outputs an array of JSON objects, each representing a document retrieved from the specified catalog. Each item in the output corresponds to one document's data as returned by the iTwin Component Center API. The exact structure depends on the API response but typically includes metadata and content references related to each document.
No binary data output is indicated by the source code.
Dependencies
- Requires an API key credential for authenticating with the iTwin OAuth2 service.
- Depends on the iTwin Component Center API being accessible.
- The node uses an internal interpreter module (
ComponentCenterOpenApiInterpreter) to map operations and execute API calls.
Troubleshooting
- Unknown operation error: If the operation parameter is incorrect or unsupported, the node throws an error indicating an unknown operation. Ensure the operation name is exactly "get-catalog-documents".
- API authentication failures: Missing or invalid API credentials will cause authentication errors. Verify that the required API key or OAuth2 token is correctly configured.
- Empty or invalid Catalog ID: Providing an empty or invalid catalog ID may result in no documents returned or API errors. Confirm the catalog ID is correct and exists.
- Network or API downtime: Connectivity issues or API service interruptions can cause execution failures. Check network connectivity and iTwin service status.
The node supports continuing on failure if enabled, allowing partial processing without stopping the entire workflow.
Links and References
- iTwin Developer Documentation
- n8n Documentation on Creating Custom Nodes