iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Overview

This node integrates with the iTwin Component Center API to update an existing application’s details. It is designed to modify key attributes of an application such as its display name and version by sending an update request to the API.

Common scenarios where this node is beneficial include:

  • Automating updates to application metadata in a CI/CD pipeline.
  • Synchronizing application information across multiple systems.
  • Managing application versions programmatically without manual intervention.

For example, you might use this node to update the display name and version of an application after a new release is published, ensuring that all connected systems reflect the latest information.

Properties

Name Meaning
ID The unique identifier of the application to update. This is required to specify which application record should be modified.
Display Name The new display name for the application. Must be a string up to 250 characters and cannot include special characters: >, <, ^, $, ?, `
Version The new version string for the application. Also limited to 250 characters and disallows the same special characters as the display name.
Options Additional options for the update operation. Currently supports:
- Custom Payload: Allows overriding the default request body with a custom JSON payload. Useful if you need to send a specific structure not covered by standard fields.

Output

The node outputs JSON data representing the response from the iTwin Component Center API after attempting to update the application. The output typically contains the updated application object or relevant status information returned by the API.

If a custom payload is used, the output reflects the API's response to that payload.

No binary data output is produced by this node.

Dependencies

  • Requires an API authentication token credential configured in n8n to authorize requests against the iTwin Component Center API.
  • The node depends on the internal ComponentCenterOpenApiInterpreter module to map operations and execute API calls.
  • Network access to the iTwin Component Center API endpoint is necessary.

Troubleshooting

  • Unknown operation error: If the specified operation is not recognized, ensure the "Update Application" operation is correctly selected.
  • Validation errors: Input fields like Display Name and Version have character restrictions; violating these will cause API errors. Remove forbidden characters and keep length under 250.
  • Authentication failures: Verify that the API key or OAuth2 credentials are valid and have sufficient permissions.
  • Custom payload issues: When using a custom JSON payload, ensure it is well-formed and matches the API schema expected by the update endpoint.
  • Continue on Fail: If enabled, the node will return error details in the output JSON instead of stopping execution, useful for debugging batch operations.

Links and References

  • iTwin Developer Documentation
  • Refer to the official iTwin Component Center API docs for detailed schema and examples of the update application endpoint.

Discussion