Overview
This node interacts with the iTwin Projects API to retrieve multiple project records based on specified filters and pagination options. It is useful when you want to fetch a list of projects from the iTwin platform, for example, to display active projects, search projects by name or type, or integrate project data into workflows.
Typical use cases include:
- Retrieving all active projects for reporting or dashboard purposes.
- Searching projects by keywords or filtering by project type.
- Limiting the number of returned projects for performance or UI constraints.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching projects or only up to a specified limit. |
| Limit | Maximum number of projects to return (used only if "Return All" is false). |
| Filters | Collection of filters to narrow down the projects: |
| - Status | Filter projects by status; options are: Active, Inactive, Trial. |
| - Search | Text string to search/filter projects by name or other searchable fields. |
| - Type | Filter projects by their type (string). |
| - Sub Class | Filter by iTwin subclass; defaults to "Project". |
Output
The output is an array of JSON objects representing projects retrieved from the iTwin API. Each object corresponds to a single project and contains its properties as returned by the API, such as project ID, display name, status, type, and other metadata.
If "Return All" is true, all matching projects are returned; otherwise, the output contains up to the specified limit.
No binary data is output by this node.
Dependencies
- Requires an API authentication token credential for the iTwin OAuth2 API.
- The node uses internal helper functions to make HTTP requests to the iTwin Projects API endpoints.
- Network access to the iTwin API service is necessary.
Troubleshooting
Common issues:
- Authentication failures due to invalid or expired API tokens.
- No projects returned if filters are too restrictive or incorrect.
- Rate limiting or network errors from the iTwin API.
Error messages:
- Errors from the API will be thrown and can be caught if "Continue On Fail" is enabled.
- Typical error messages include authorization errors, invalid parameters, or server errors.
Resolutions:
- Verify that the API credentials are correctly configured and valid.
- Adjust filter criteria to ensure they match existing projects.
- Check network connectivity and API service status.