iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Actions58

Overview

This node integrates with the iTwin Component Center API to upload design components. Specifically, the "Upload Component" operation allows users to upload a design file along with metadata such as component name, description, associated application, category, manufacturer, and tags. This is useful for managing and cataloging design components in a centralized repository, enabling easier reuse and sharing within engineering or architectural projects.

Practical examples include:

  • Uploading a new electrical component design file with detailed metadata for use in a building information model.
  • Adding a mechanical part to a shared component library with searchable tags and references to catalogs.
  • Managing component versions by uploading updated files with descriptions and associations.

Properties

Name Meaning
File Name Name of the design file to be uploaded.
Component Name Display name of the component.
Description Description of the component.
Application Associated application ID (string GUID) that links the component to an existing application.
Category Associated category ID (string GUID) linking the component to a category.
Manufacturer Associated manufacturer ID (string GUID) linking the component to a manufacturer.
Search Tags Hashtags assigned to the component, provided as a JSON array.
Catalogs Referenced catalogs of the component, provided as a JSON array.
Is Type Catalog Boolean flag specifying if the component is a TypeCatalog.
Options Collection allowing custom payload override:
- Custom Payload If enabled, allows sending a fully custom JSON payload instead of the standard request body.

Output

The node outputs an array of JSON objects representing the response from the iTwin Component Center API after uploading the component. Each item corresponds to the result of the upload operation for each input item.

  • The json output field contains the API response data, which typically includes details about the uploaded component such as its ID, status, and metadata.
  • No binary data output is indicated.

Dependencies

  • Requires an OAuth2 API credential for authentication with the iTwin Component Center API.
  • The node depends on the bundled ComponentCenterOpenApiInterpreter module to interpret and execute API operations.
  • Proper configuration of the OAuth2 credentials and network access to the iTwin API endpoint is necessary.

Troubleshooting

  • Unknown operation error: If the specified operation is not recognized, ensure the operation name is correctly set to "upload-component".
  • Invalid GUID errors: Application, category, or manufacturer IDs must be valid GUID strings referencing existing entities; invalid values will cause API errors.
  • JSON parsing errors: For properties like Search Tags and Catalogs, ensure the JSON input is well-formed.
  • Authentication failures: Verify that the OAuth2 credentials are correctly configured and have sufficient permissions.
  • Custom Payload issues: When using the custom payload option, ensure the JSON structure matches the API requirements; malformed payloads may cause request failures.

Links and References

Discussion