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 job action details related to iTwin jobs. Specifically, the "Get iTwin job actions" operation fetches information about actions associated with a particular iTwin job by using identifiers such as the action ID and the job ID.

Common scenarios for this node include:

  • Monitoring or auditing specific actions performed within an iTwin job.
  • Integrating iTwin job action data into workflows for reporting or triggering subsequent automation steps.
  • Fetching detailed metadata about job actions to support decision-making or error handling in larger automation pipelines.

For example, a user might use this node to get all actions related to a construction project job in iTwin, then analyze those actions to ensure compliance or progress tracking.

Properties

Name Meaning
ID The unique identifier of the specific action to retrieve within the iTwin job.
Job ID The unique identifier of the iTwin job whose actions are being queried.

Both properties are required string inputs that specify which job and which action within that job the node should fetch.

Output

The node outputs JSON data representing the details of the requested iTwin job action(s). The structure typically includes metadata and attributes describing the action, such as timestamps, status, type, and any relevant parameters or results associated with the action.

If multiple actions are returned, the output is an array of JSON objects, each corresponding to one action.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API authentication token credential for the iTwin platform (referred generically as an API key credential).
  • Depends on the iTwin Users & Access Control API.
  • The node internally uses an interpreter module (UsersOpenApiInterpreter) to map operations and execute API calls.
  • Proper configuration of the OAuth2 credentials or API keys in n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Missing or invalid ID or Job ID parameters will cause the node to fail or return errors.
    • Authentication failures due to misconfigured or expired API credentials.
    • Network or API endpoint unavailability can cause timeouts or connection errors.
  • Error messages:

    • "Unknown operation: <operation>": This indicates that the specified operation name does not match any known operation in the interpreter. Verify the operation parameter spelling.
    • Errors related to API calls will typically include messages from the iTwin API; ensure credentials and permissions are correct.
    • If the node is set to continue on failure, errors will be returned inside the JSON output under an error field with a message and node info.

Links and References

Discussion