iTwin Forms icon

iTwin Forms

Comprehensive iTwin Forms API

Actions28

Overview

This node interacts with the iTwin Forms API to retrieve form data associated with a specific iTwin or project. It is designed to fetch detailed form information, supporting pagination and filtering by various criteria such as form type, workflow state, and discipline.

Common scenarios where this node is beneficial include:

  • Extracting form submissions for reporting or analysis within an iTwin project.
  • Automating workflows that depend on the status or type of forms submitted in an iTwin environment.
  • Integrating iTwin form data into other systems or dashboards for real-time monitoring.

For example, a user might use this node to get all open inspection forms related to a particular iTwin project, then trigger notifications or further processing based on the retrieved data.

Properties

Name Meaning
iTwin ID The GUID of the iTwin or project to get forms for. (Also accepts "projectId" as an alias.)
Continuation Token A token to continue fetching the next page of results from a previous paged query. Must be passed exactly as received. If omitted, defaults to the first page or previous page size.
Type The type of form data to retrieve. If omitted, all types are returned.
State Filter to get form data only for a specific workflow state: Open, Draft, or Closed.
Discipline Filter to get form data for a specific discipline. If omitted, all disciplines are included.

Output

The node outputs JSON objects representing the form data retrieved from the iTwin Forms API. Each output item corresponds to one form record or a collection of form records depending on the API response.

  • The json field contains the form data as returned by the API.
  • If the API supports pagination, the output may include continuation tokens or links to fetch subsequent pages.
  • No binary data output is indicated for this operation.

Dependencies

  • Requires an API authentication credential configured in n8n to access the iTwin OAuth2 secured API.
  • The node depends on the iTwin Forms API endpoint, which must be accessible from the n8n environment.
  • Proper permissions on the iTwin project or iTwin ID are necessary to retrieve form data.

Troubleshooting

  • Common issues:

    • Invalid or missing iTwin ID/project GUID will cause the API call to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Passing an invalid continuation token may lead to empty results or errors.
    • Filtering by unsupported or misspelled form types, states, or disciplines may return no data.

  • Error messages:

    • "Unknown operation": Indicates the specified operation name is not recognized; ensure "Get iTwin form data" is selected.
    • Authentication errors typically indicate misconfigured or expired API credentials.
    • API rate limits or network issues may cause request failures; retry or check connectivity.

Links and References

Discussion