iTwin Issues icon

iTwin Issues

iTwin Issues API for issue management, form definitions, attachments, and comments

Actions27

Overview

This node integrates with the iTwin Issues API to update existing issues within an iTwin project. It allows users to modify various attributes of an issue such as its subject, description, due date, status, assignees, and origin information like model views or geographical location. This is useful in scenarios where issue tracking and management need to be automated or integrated into workflows, for example:

  • Automatically updating issue statuses based on external triggers.
  • Adding workflow notes when transitioning issue states.
  • Assigning or reassigning issues programmatically.
  • Updating metadata related to 3D models or files associated with issues.

Properties

Name Meaning
ID The unique identifier of the issue to modify (required).
Subject Brief title or description of the issue.
Description Detailed description of the issue.
Due Date The deadline by which action should be taken on this issue; used to determine if the issue is near due or overdue.
Status The new workflow status of the issue, if applicable.
Workflow Note A comment text associated with the status change. Must only be set if 'Status' is also set and the workflow allows adding a note for that transition.
Assignee JSON object describing the primary user or role assigned to the issue.
Assignees JSON array listing multiple users or roles assigned to the issue, for cases with multiple assignees.
Source Entity JSON object representing a file in storage related to the issue.
Bounding Box JSON object describing a rectangular-prism-shaped region in a 3D model relevant to the issue.
Model Pin JSON object associating the issue with a single point in a model, not necessarily linked to a model element.
Model View JSON object describing the view visible when the issue was created.
Model Event Date Time Date and time represented in the model where the issue occurred (useful for 4D models).
Location JSON object describing the geographical location relevant to the issue.
Properties JSON object containing customizable properties depending on project-specific configurations.
Options > Custom Payload Allows overriding the request body with a custom JSON payload instead of using the standard fields.

Output

The node outputs an array of JSON objects representing the updated issue(s) returned from the iTwin Issues API after modification. Each output item contains the full representation of the issue including all updated fields.

If the "Custom Payload" option is enabled, the output corresponds to the response of the custom JSON sent.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the iTwin platform via an OAuth2 API credential.
  • The node depends on the iTwin Issues API endpoint at https://api.bentley.com.
  • Proper permissions and scopes must be granted to the API key/token to allow issue modifications.
  • No additional environment variables are explicitly required beyond the configured API credentials.

Troubleshooting

  • Error: Unsupported operation — This occurs if an operation other than those supported (like "modify-issue") is requested. Ensure the correct operation is selected.
  • API authentication errors — Verify that the OAuth2 credentials are valid and have the necessary scopes.
  • Invalid JSON in properties like Assignee or Assignees — These fields expect valid JSON strings; malformed JSON will cause failures. Use proper JSON formatting.
  • Workflow Note without Status — Setting a workflow note without also setting a status will likely cause API rejection. Always set status when providing a workflow note.
  • Empty or missing ID — The issue ID is mandatory; omitting it will prevent the node from identifying which issue to update.
  • If the node fails but "Continue On Fail" is enabled, error details will be included in the output JSON under an error property.

Links and References

Discussion