iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Overview

This node interacts with the iTwin Component Center API to retrieve information about applications. Specifically, the "Get Application" operation fetches details of a single application by its unique identifier. This is useful in scenarios where you need to integrate or automate workflows involving iTwin applications, such as monitoring application metadata, syncing app data, or triggering actions based on application properties.

Practical examples include:

  • Fetching an application's details to display in a dashboard.
  • Using application metadata to conditionally route workflow execution.
  • Automating updates or audits of applications registered in the iTwin Component Center.

Properties

Name Meaning
ID The unique identifier of the application to retrieve. This is a required string input specifying which application’s details to fetch.

Output

The node outputs JSON data representing the retrieved application object from the iTwin Component Center API. The structure typically includes all relevant fields describing the application, such as its name, version, description, and other metadata provided by the API.

If multiple items were returned (not typical for this operation), each would be output as a separate JSON object. No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential for the iTwin OAuth2 service to authorize requests.
  • Depends on the iTwin Component Center API being accessible and the user having appropriate permissions.
  • The node uses an internal interpreter module to map operations and execute API calls.

Troubleshooting

  • Common issues:

    • Providing an invalid or empty application ID will result in errors or no data returned.
    • Authentication failures if the API key or OAuth token is missing, expired, or incorrect.
    • Network connectivity problems preventing access to the iTwin Component Center API.
  • Error messages:

    • "Unknown operation: get-application" indicates the operation parameter was not recognized; ensure it is correctly set.
    • Errors related to failed API calls will include messages from the API response; verify credentials and application ID.
    • If continueOnFail is enabled, errors are returned as JSON objects with an error field describing the issue.

Links and References

Discussion