iTwin Forms

Overview

This node integrates with the iTwin Forms API, allowing users to interact with form data within the iTwin platform. Specifically, the "Get audit trail for form data" operation retrieves the complete audit trail for a given form data instance. This is useful for tracking changes, monitoring user actions, and maintaining compliance or data integrity by reviewing who modified the form data and when.

Practical examples include:

• Auditing changes made to critical forms in engineering projects.
• Generating reports on form data modifications for compliance purposes.
• Debugging issues by reviewing the history of form data updates.

Properties

Output

The output is a JSON object (or an array of objects) representing the audit trail details for the specified form data instance. Each entry typically contains information about individual changes or events related to the form data, such as timestamps, user identifiers, and descriptions of the actions performed.

If multiple audit entries exist, the output will be an array of JSON objects, each corresponding to a single audit record.

No binary data output is indicated for this operation.

Dependencies

• Requires an API authentication token credential configured in n8n to connect securely to the iTwin Forms API.
• The node depends on the FormsOpenApiInterpreter class internally to map and execute API operations.
• Network connectivity to the iTwin Forms API endpoint is necessary.
• Proper permissions on the iTwin platform to access form data and its audit trails.

Troubleshooting

• Common Issues:

  • Providing an invalid or non-existent form data ID will likely result in an error or empty response.
  • Missing or incorrect API credentials will cause authentication failures.
  • Network issues or API downtime can prevent successful retrieval.

• Error Messages:

  • "Unknown operation: <operation>": Indicates that the specified operation name is not recognized by the node. Ensure the operation parameter is correctly set to "get-audit-trail-for-form-data".
  • Errors containing "iTwin Forms execution failed" indicate runtime issues during API calls; check credentials, network, and input parameters.

• Resolutions:

  • Verify the form data ID is correct and exists.
  • Confirm API credentials are valid and have sufficient permissions.
  • Enable "Continue On Fail" if partial processing is acceptable and to handle errors gracefully.

Links and References

• iTwin Developer Documentation
• Refer to the official iTwin Forms API documentation for detailed schema and audit trail specifics.