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 components related to a specific brand. The "Get Brand Components" operation fetches all components associated with a given brand ID, optionally filtered by a search string that matches component hashtags or display names.
Common scenarios include:
- Listing all components available under a particular brand for further processing or display.
- Searching within a brand's components to find those matching certain keywords in their tags or names.
Practical example:
- A user wants to automate fetching all UI components from a specific brand to update a catalog or synchronize with another system.
Properties
| Name | Meaning |
|---|---|
| Brand ID | The unique identifier of the brand whose components you want to retrieve. |
| Search | Optional search string to filter components by matching anywhere in their hashtags or display names. |
Output
The output is an array of JSON objects, each representing a component retrieved from the iTwin Component Center for the specified brand. Each object contains the component's details as returned by the API.
No binary data output is indicated.
Dependencies
- Requires an API authentication token credential for the iTwin OAuth2 service.
- The node depends on the iTwin Component Center API being accessible.
- No additional environment variables are explicitly required beyond the API credentials.
Troubleshooting
- Unknown operation error: If the operation parameter is incorrect or unsupported, the node throws an error indicating "Unknown operation". Ensure the operation name is exactly "get-brand-components".
- API authentication failures: Missing or invalid API credentials will cause authentication errors. Verify that the OAuth2 API key is correctly configured.
- Empty results: If no components match the brand ID or search criteria, the output will be empty. Confirm the brand ID is correct and the search term (if used) is valid.
- Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.
Links and References
- iTwin Developer Documentation
- iTwin Component Center API Reference (general link; specific endpoint docs not included in source)