iTwin Forms

Overview

This node integrates with the iTwin Forms API, allowing users to interact with form definitions and their associated list groups. Specifically, the "Get list group" operation retrieves details about a particular list group within a specified form definition. This is useful in scenarios where you need to fetch metadata or configuration of list groups used in forms, such as for dynamic form rendering, validation, or data processing workflows.

Practical examples include:

• Fetching a list group's details to display options dynamically in a user interface.
• Validating form submissions against the list group's configuration.
• Synchronizing list group data with other systems.

Properties

Output

The node outputs JSON data representing the retrieved list group details. The structure depends on the iTwin Forms API response but generally includes all relevant properties of the list group such as its fields, settings, and metadata.

If multiple results were returned (though unlikely for a single get operation), each would be output as a separate JSON object. No binary data output is indicated.

Example output snippet (conceptual):

{
  "id": "listGroupId",
  "name": "List Group Name",
  "fields": [
    {
      "fieldId": "field1",
      "label": "Field Label",
      "type": "string"
    }
  ],
  "settings": {
    "someSetting": true
  }
}

Dependencies

• Requires an API authentication credential for the iTwin platform (an OAuth2 token).
• Depends on the iTwin Forms API being accessible.
• The node uses an internal OpenAPI interpreter to execute operations against the iTwin Forms API.

Troubleshooting

• Common issues:

  • Invalid or missing form definition ID or list group ID will cause errors.
  • Authentication failures if the API key or OAuth token is invalid or expired.
  • Network connectivity issues preventing access to the iTwin Forms API.

• Error messages:

  • "Unknown operation: <operation>" indicates an unsupported or misspelled operation name.
  • Errors from the API are passed through; check the error message for details like "Not Found" or "Unauthorized".

• Resolutions:

  • Verify that the IDs provided are correct and exist in the iTwin Forms system.
  • Ensure the API credentials are valid and have necessary permissions.
  • Check network connectivity and API endpoint availability.

Links and References

• iTwin Developer Documentation
• Refer to the iTwin Forms API documentation for detailed schema and usage examples.