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 jobs. Specifically, the "Get Job" operation fetches details of a single job by its unique identifier. This is useful in scenarios where you need to monitor or manage specific jobs within the iTwin platform, such as checking job status, results, or metadata.

Practical examples include:

  • Automating retrieval of job statuses for reporting or alerting.
  • Integrating job data into workflows that depend on job completion or output.
  • Fetching job details to trigger subsequent processing steps.

Properties

Name Meaning
ID The unique identifier of the job to retrieve. This is required to specify which job's details should be fetched.

Output

The node outputs JSON data representing the job details retrieved from the iTwin Component Center API. The structure typically includes all relevant information about the job, such as its status, creation time, progress, and any associated metadata.

If multiple jobs were returned (not applicable here since this operation gets a single job), the output would be an array of JSON objects. For this operation, the output is a single JSON object per input item.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Component Center API.
  • The node depends on the iTwin OAuth2 authentication mechanism configured in n8n.
  • Internet access to the iTwin Component Center API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent job ID will likely result in an error or empty response.
    • Missing or incorrect API credentials will cause authentication failures.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • "Unknown operation: get-job": This indicates the operation parameter was not recognized; ensure the operation name is correct.
    • Errors related to authentication failure suggest checking the API key or OAuth2 token configuration.
    • If the node returns an error message wrapped in JSON under error, enabling "Continue On Fail" allows workflow continuation while logging the issue.

Links and References

Discussion