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 interacts with the iTwin Component Center API to retrieve information about a specific brand. The "Get Brand" operation fetches details of a brand by its unique identifier. This is useful in scenarios where you need to integrate or synchronize brand data from the iTwin Component Center into your workflows, such as displaying brand metadata, validating brand existence, or enriching other datasets with brand information.
Practical examples:
- Fetching brand details to display in a dashboard.
- Validating a brand ID before creating related components.
- Automating updates or reports based on brand attributes.
Properties
| Name | Meaning |
|---|---|
| Brand ID | The unique identifier of the brand to retrieve. This is a required string input. |
Output
The node outputs JSON data representing the brand's details as returned by the iTwin Component Center API. The exact structure depends on the API response but typically includes brand metadata such as name, description, and identifiers.
If the operation returns multiple items (unlikely for a single brand fetch), each item will be output as a separate JSON object in the array.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the iTwin OAuth2 service.
- Needs network access to the iTwin Component Center API endpoint.
- The node uses an internal interpreter module to map operations to API calls.
Troubleshooting
Common issues:
- Invalid or missing Brand ID: Ensure the Brand ID is correctly provided and exists in the iTwin Component Center.
- Authentication errors: Verify that the API key credential is valid and has necessary permissions.
- Network or API downtime: Check connectivity and API status.
Error messages:
Unknown operation: Indicates the specified operation is not recognized; ensure "Get Brand" is selected.- API errors returned from the service will be passed through; check error messages for details.
- If
continueOnFailis enabled, errors will be included in the output JSON under anerrorfield.
Links and References
- iTwin Developer Documentation
- iTwin Component Center API documentation (linked from the above)