iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Actions58

Overview

This node integrates with the iTwin Component Center API to create new applications within the platform. It allows users to specify key details about an application, such as its display name and version, and optionally send a custom JSON payload to override the default request body.

Common scenarios for this node include:

  • Automating the creation of new software applications in the iTwin ecosystem.
  • Integrating application registration into CI/CD pipelines.
  • Managing application metadata programmatically without manual UI interaction.

For example, a user might use this node to register a new version of their application automatically after a successful build, specifying the display name and version number, or sending a fully customized payload if the default parameters are insufficient.

Properties

Name Meaning
Display Name The display name of the application. Must be a string up to 250 characters and cannot include special characters: >, <, ^, $, ?, `
Version The version of the application. Must be a string up to 250 characters and cannot include special characters: >, <, ^, $, ?, `
Options Additional options for the request.
  Use Custom Payload Boolean flag to override the default request body with a custom JSON payload.
  JSON Payload When enabled, this is the custom JSON payload sent to the API instead of the standard parameters.

Output

The node outputs JSON data representing the response from the iTwin Component Center API after creating the application. The structure typically contains details about the newly created application or error information if the operation failed.

If a custom payload is used, the output corresponds directly to 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 access the iTwin Component Center API.
  • The node depends on the bundled ComponentCenterOpenApiInterpreter module to interpret and execute API operations.
  • Network connectivity to the iTwin Component Center API endpoint is necessary.

Troubleshooting

  • Invalid Characters in Input: If the display name or version includes forbidden special characters (>, <, ^, $, ?, ||), the API may reject the request. Ensure inputs conform to the restrictions.
  • Missing Required Fields: Both "Display Name" and "Version" are required. Omitting them will cause errors.
  • API Authentication Errors: Ensure the API key or OAuth2 credentials are correctly set up and have sufficient permissions.
  • Custom Payload Issues: When using a custom JSON payload, ensure it is valid JSON and matches the API schema expected by the iTwin Component Center.
  • Unknown Operation Error: If the operation parameter is incorrect or unsupported, the node throws an "Unknown operation" error. Verify the operation name is exactly "create-application".

Links and References

Discussion