Actions54
- Resource Actions
- Userpermissions Actions
- Baselinefile Actions
- Locks Actions
- Briefcases Actions
- Checkpoint Actions
- Thumbnail Actions
- Extendeddata Actions
- Changesets Actions
- Changesetgroups Actions
- Permissions Actions
- Recents Actions
- Namedversions Actions
- Shares Actions
- Rolepermissions Actions
- Users Actions
- Favorites Actions
- Fork Actions
- Clone Actions
- Create Actions
Overview
This node interacts with the iTwin Platform iModels API, specifically allowing users to add an iModel to their favorites list. It is useful in scenarios where users want to quickly bookmark or mark specific iModels for easy access later within workflows that manage or monitor iModels.
For example, a user managing multiple iModels might automate adding frequently used or important iModels to their favorites automatically after certain events or conditions are met, streamlining their workflow and improving efficiency.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel to add to the user's favorites. |
| Options | Additional options for the request: |
| Custom Payload | Allows overriding the default request body with a custom JSON payload. This can be enabled or disabled. When enabled, the user provides the exact JSON to send to the API. |
Output
The node outputs JSON data representing the response from the iTwin Platform API after attempting to add the specified iModel to the favorites. The structure depends on the API's response but generally includes confirmation of the addition or error details if the operation failed.
No binary data output is produced by this node.
Dependencies
- Requires an API authentication token credential for the iTwin Platform (OAuth2-based).
- The node uses an internal interpreter module to map operations to API calls.
- Network connectivity to the iTwin Platform API endpoint is necessary.
Troubleshooting
- Common issues:
- Invalid or missing iModel ID will cause the API call to fail.
- Authentication errors if the API token is expired or invalid.
- Network connectivity problems preventing communication with the iTwin Platform.
- Error messages:
"Unknown operation: add-imodel-to-my-favorites"indicates a misconfiguration or typo in the operation name.- API errors returned in the JSON response will be passed through; check the message for details.
- Resolutions:
- Ensure the "ID" property is correctly set to a valid iModel identifier.
- Verify that the API credentials are properly configured and authorized.
- Enable "Continue On Fail" in the node settings to handle errors gracefully during batch executions.
Links and References
- iTwin Platform Developer Documentation
- n8n documentation on Using OAuth2 Credentials