iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Actions58

Overview

This node integrates with the iTwin Component Center API to update a specific component variation. It allows users to modify details of an existing variation of a component, such as its display name, associated design document, and custom properties.

Common scenarios include:

  • Updating metadata or descriptive information for a component variation in a design system.
  • Modifying ad hoc properties that are not part of the standard schema.
  • Overriding the request payload with a custom JSON structure for advanced use cases.

Practical example:

  • A user wants to rename a variation of a UI component to better reflect its purpose.
  • Adding or updating additional properties related to the variation without changing the core component.
  • Sending a fully customized payload to the API when the default parameters do not cover a specific need.

Properties

Name Meaning
Component ID The unique identifier of the component whose variation is being updated.
Variation ID The unique identifier of the variation to update.
Display Name The new display name for the variation. Must be at most 250 characters and cannot include special characters: >, <, ^, $, ?, `
Associated Design Document The ID of the design document associated with this variation.
Ad Hoc Properties A JSON array representing additional custom properties for the variation. These are flexible key-value pairs defined by the user.
Options → Custom Payload Optionally override the entire request body with a custom JSON payload. This includes:
- Use Custom Payload (boolean): Whether to send a custom payload instead of the standard parameters.
- JSON Payload: The actual JSON object to send if enabled.

Output

The node outputs an array of items where each item contains a json field representing the response from the API after updating the component variation.

  • If the API returns an array, each element is output as a separate item.
  • If the API returns an object, it is output as a single item.
  • If the response is a primitive or other type, it is wrapped inside an object under the result key.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API authentication token credential to access the iTwin Component Center API.
  • Uses an internal interpreter module (ComponentCenterOpenApiInterpreter) to map operations and execute API calls.
  • No external environment variables are explicitly required beyond the API credentials.

Troubleshooting

  • Unknown operation error: If the specified operation is not recognized, the node throws an error "Unknown operation". Ensure the operation parameter is correctly set to "update-component-variation".
  • Invalid input parameters: Missing or invalid componentId or variationId will cause the API call to fail. Verify these IDs are correct and exist in the system.
  • Display name validation: The display name must not exceed 250 characters and cannot contain certain special characters. Violating this will likely result in an API error.
  • Custom payload errors: If using the custom payload option, ensure the JSON is valid and matches the expected API schema; otherwise, the request may fail.
  • API authentication issues: Make sure the API key or OAuth token is valid and has sufficient permissions.

If the node is set to continue on failure, errors will be returned in the output JSON under an error key with a message and node info.

Links and References

Discussion