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 Changeset Group within an iModel. It allows users to modify the state of a Changeset Group, which is useful for managing the lifecycle of changesets in digital twins or infrastructure models.
Common scenarios include:
- Marking a Changeset Group as completed after all changes are finalized.
- Updating the status to indicate progress or timeout conditions.
- Forcibly closing a Changeset Group if necessary.
Practical example:
- After uploading and validating a batch of changes to an iModel, you can use this node to set the Changeset Group state to "Completed" to signal that no further changes will be added.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel to which the Changeset Group belongs. |
| Changeset Group ID | The unique identifier of the Changeset Group to update. |
| State | The new state of the Changeset Group. Options: In Progress, Completed, Timed Out, Forcibly Closed. Should typically be set to "Completed". |
| Options | Additional options for the request. Includes: |
| - Custom Payload | Allows overriding the request body with a custom JSON payload instead of the standard parameters. |
Output
The node outputs JSON data representing the response from the iTwin Platform API after updating the Changeset Group. This typically includes details about the updated Changeset Group such as its new state and metadata.
No binary data output is indicated.
Dependencies
- Requires an API authentication token credential for the iTwin Platform (OAuth2).
- Depends on the iTwin Platform's REST API being accessible.
- Uses an internal OpenAPI interpreter module to map operations and execute requests.
Troubleshooting
Common issues:
- Invalid or missing iModel ID or Changeset Group ID will cause errors.
- Setting an invalid state value not among the allowed options may result in API rejection.
- Network or authentication failures when connecting to the iTwin Platform API.
Error messages:
"Unknown operation": Indicates the specified operation name is not recognized by the node; ensure "update-imodel-changeset-group" is selected.- API errors returned from the platform will be passed through; check the error message for details like invalid IDs or permission issues.
Resolutions:
- Verify all required fields are correctly filled.
- Ensure the API credentials are valid and have sufficient permissions.
- Use the "Custom Payload" option carefully to avoid malformed JSON.