Actions28
- Attachments Actions
- Comments Actions
- Import Actions
- Static Images Actions
- Forms Actions
- Delete form definition
- Update form definition metadata
- Get form definition by ID
- Add comment to form
- Get form data comments
- Download form as file
- Export forms to Storage
- Get form data details
- Update form data
- Delete form data
- Import form definition from another iTwin
- Get iTwin form definitions
- Add attachment to form
- Get form data attachments
- Create form data
- Get iTwin form data
- Get audit trail for form data
- List Groups Actions
- Templates Actions
- Workflows Actions
Overview
This node interacts with the iTwin Forms API to retrieve information about list groups associated with a specific iTwin. The "Get iTwin list groups" operation fetches groups of lists that belong to an iTwin, optionally filtered by a search string matching their display names.
Common scenarios include:
- Retrieving all list groups for a given iTwin to display or process them further.
- Searching for specific list groups by partial name matches to narrow down results.
- Integrating iTwin list group data into workflows for reporting, synchronization, or automation purposes.
For example, a user might want to get all list groups related to a project (iTwin) and then use those groups to populate dropdowns or validate inputs in subsequent workflow steps.
Properties
| Name | Meaning |
|---|---|
| iTwin ID | The unique identifier of the iTwin for which to retrieve list groups. This is required. |
| Search | Optional string to filter list groups by their display names. Only groups containing this string will be returned. |
Output
The node outputs an array of JSON objects representing the list groups retrieved from the iTwin Forms API. Each item corresponds to one list group and contains its properties as returned by the API.
If multiple list groups are returned, each is output as a separate JSON object in the output array.
No binary data is produced by this node.
Dependencies
- Requires an API authentication credential for the iTwin platform (an OAuth2 token or similar).
- Depends on the iTwin Forms API being accessible and the provided iTwin ID being valid.
- The node uses an internal OpenAPI interpreter class to execute operations against the iTwin Forms API.
Troubleshooting
- Invalid iTwin ID: If the iTwin ID is incorrect or does not exist, the API may return an error or empty results. Verify the ID before running the node.
- Authentication errors: Ensure the API credential is correctly configured and has sufficient permissions to access the iTwin Forms API.
- Empty results when using Search: If no list groups match the search string, the output will be empty. Try broadening or removing the search filter.
- Unknown operation error: This indicates the operation parameter was set incorrectly. Confirm that "get-itwin-list-groups" is selected as the operation.
Links and References
- iTwin Developer Documentation
- iTwin Forms API Reference (general link; specific endpoint docs should be found here)