iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Actions58

Overview

This node updates an existing catalog in the iTwin Component Center. It allows users to modify catalog properties such as display name, description, region, and hashtags. This is useful for maintaining up-to-date metadata about catalogs that organize components or documents within the iTwin ecosystem.

Typical use cases include:

  • Renaming a catalog to reflect updated content or organizational changes.
  • Adding or updating descriptive information to improve catalog searchability.
  • Changing the regional classification of a catalog.
  • Managing hashtags to enhance catalog tagging and filtering.

For example, a user might update a catalog's display name and description after reorganizing project components or correcting metadata errors.

Properties

Name Meaning
ID The unique identifier of the catalog to update.
Display Name The new display name for the catalog. Must be at most 250 characters and cannot contain special characters: >, <, ^, $, ?, `
Description A textual description of the catalog, up to 250 characters.
Region The region associated with the catalog, up to 250 characters.
Hashtags A JSON array of hashtags related to the catalog. Each hashtag can be up to 50 characters and must not include special characters: >, <, ^, $, ?, `
Options Additional options including:
- Custom Payload: Allows overriding the request body with a custom JSON payload instead of using the standard fields. Useful for advanced use cases where the default schema does not suffice.

Output

The node outputs the response from the API call to update the catalog. The output is structured as JSON and typically contains the updated catalog data or confirmation of the update operation.

  • The main output field is json, which holds the API response object.
  • If a custom payload is used, the output reflects the response to that payload.
  • No binary data output is expected from this node.

Example output structure (simplified):

{
  "id": "catalog-id",
  "displayName": "Updated Catalog Name",
  "description": "Updated description",
  "region": "Updated region",
  "hashtags": ["#example", "#updated"]
}

Dependencies

  • Requires an API key credential or OAuth2 token configured in n8n to authenticate with the iTwin Component Center API.
  • The node depends on the iTwin Component Center API being accessible and the user having permissions to update catalogs.
  • No additional external dependencies are required beyond the API access.

Troubleshooting

  • Invalid ID error: Ensure the catalog ID provided exists and is correct.
  • Validation errors on fields: Check that the display name, description, region, and hashtags conform to length limits and do not contain forbidden special characters.
  • Authentication failures: Verify that the API credentials are correctly set up and have sufficient permissions.
  • Malformed JSON in hashtags or custom payload: When entering JSON for hashtags or custom payload, ensure it is valid JSON syntax.
  • Unknown operation error: This should not occur if the operation is set to "Update Catalog" but indicates a misconfiguration or code issue.

If the node throws an error and "Continue On Fail" is enabled, the error message will be included in the output JSON under an error property.

Links and References

Discussion