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 related to specific components within projects. The "Get Component Documents" operation fetches all documents associated with a given component ID, optionally filtered by a project ID. This is useful for scenarios where users need to programmatically access documentation or metadata tied to components in their digital twin projects.
Practical examples include:
- Automatically retrieving and displaying component manuals or specifications in a dashboard.
- Integrating component documentation into a project management workflow.
- Archiving or analyzing component-related documents for compliance or auditing purposes.
Properties
| Name | Meaning |
|---|---|
| Component ID | The unique identifier of the component whose documents you want to retrieve. (Required) |
| Project ID | The unique identifier of the project to which the component belongs. Optional query parameter to filter documents by project. |
Output
The node outputs an array of JSON objects representing the documents associated with the specified component. 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 document metadata such as document ID, name, description, and possibly URLs or references to the document content.
No binary data output is indicated by the source code.
Dependencies
- Requires an API authentication token credential for the iTwin OAuth2 service to authorize requests to the iTwin Component Center API.
- The node uses an internal interpreter module (
ComponentCenterOpenApiInterpreter) to map operations and execute API calls. - Proper configuration of the OAuth2 credential in n8n is necessary for successful API communication.
Troubleshooting
- Unknown operation error: If the operation parameter is incorrect or unsupported, the node throws an error indicating "Unknown operation". Ensure the operation name matches exactly "get-component-documents".
- API authentication failures: Missing or invalid OAuth2 credentials will cause authorization errors. Verify that the API key/token is correctly configured and has sufficient permissions.
- Empty or missing Component ID: Since Component ID is required, omitting it or providing an invalid value will likely result in API errors or empty results.
- Continue on Fail behavior: If enabled, the node will output error details in the JSON under an
errorfield instead of stopping execution, allowing workflows to handle failures gracefully.
Links and References
- iTwin Developer Documentation
- Refer to the official iTwin Component Center API docs for detailed information on document structures and additional parameters.