iTwin Users & Access Control icon

iTwin Users & Access Control

Comprehensive iTwin Users and Access Control API

Overview

This node interacts with the iTwin platform to retrieve information about specific jobs related to iTwin services. The "Get iTwin job" operation fetches details of a particular job by its ID, which is useful for monitoring job status, retrieving job results, or managing workflows that depend on iTwin job executions.

Practical examples include:

  • Fetching the status and metadata of a long-running iTwin job.
  • Integrating job status checks into automated workflows.
  • Triggering subsequent actions based on job completion or failure.

Properties

Name Meaning
ID The identifier of the resource context (likely the iTwin project or environment ID).
Job ID The unique identifier of the iTwin job to retrieve details for.

Output

The node outputs JSON data representing the details of the requested iTwin job. This typically includes job metadata such as status, timestamps, results, and any relevant job-specific information returned by the iTwin API.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API authentication token credential for iTwin OAuth2 API access.
  • Depends on the UsersOpenApiInterpreter module internally to handle API operations.
  • Requires proper configuration of the iTwin OAuth2 API credentials within n8n.

Troubleshooting

  • Common issues:

    • Invalid or missing job ID or resource ID parameters will cause the operation to fail.
    • Authentication errors if the OAuth2 API credentials are not set up correctly.
    • Network or API availability issues may result in request failures.
  • Error messages:

    • "Unknown operation: get-itwin-job" indicates the operation name was not recognized; ensure the correct operation is selected.
    • Errors related to failed API calls will be surfaced with their message; enabling "Continue On Fail" allows workflow continuation despite errors.
  • Resolution tips:

    • Verify that both "ID" and "Job ID" fields are correctly filled.
    • Confirm that the OAuth2 credentials are valid and have necessary permissions.
    • Check network connectivity and iTwin service status.

Links and References

Discussion