iTwin iModels
Interact with iTwin Platform iModels API for managing iModels, changesets, named versions, and more
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's iModels API, specifically to update an existing iModel Share. It allows users to modify properties of a share such as its expiration date or provide a custom payload for more advanced updates.
Common scenarios include:
- Extending or changing the validity period of an iModel Share.
- Customizing share details by sending specific JSON payloads directly to the API.
- Managing access and sharing settings programmatically within automation workflows.
Practical example:
- Automatically update the expiration date of a shared iModel link before it expires to maintain continuous access without manual intervention.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel to which the share belongs. |
| Share ID | The unique identifier of the specific share to update. |
| Expires At | A universal datetime string specifying until when the share will be valid. Recommended in ISO 8601 format (e.g., 2022-10-01T15:35:35.7777777Z). Cannot be set more than 6 months into the future. |
| Options | Additional options for the update operation: |
| - Custom Payload | Allows overriding the request body with a custom JSON payload. This is useful for advanced use cases where the standard parameters are insufficient. |
Output
The node outputs JSON data representing the response from the iTwin Platform API after updating the iModel Share. The structure typically contains the updated share information or confirmation of the update.
If a custom payload is used, the output reflects the API's response to that payload.
No binary data output is produced by this node.
Dependencies
- Requires an API authentication token credential configured in n8n to authenticate requests against the iTwin Platform API.
- The node depends on the iTwin Platform's REST API being accessible.
- No additional external dependencies beyond the provided API credentials and network access.
Troubleshooting
- Invalid or expired credentials: Ensure the API authentication token is valid and has sufficient permissions to update iModel shares.
- Invalid datetime format for "Expires At": Use ISO 8601 format and ensure the date is not set more than 6 months in the future.
- Share or iModel ID not found: Verify that the provided IDs exist and are correct.
- Custom payload errors: When using a custom JSON payload, ensure the JSON is well-formed and matches the API's expected schema.
- Network issues: Confirm network connectivity to the iTwin Platform API endpoint.
Common error messages:
"Unknown operation": Indicates the operation parameter is incorrect or unsupported.- API error responses related to authorization, invalid input, or resource not found should be reviewed and corrected accordingly.