iTwin Issues icon

iTwin Issues

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

Actions27

Overview

This node interacts with the iTwin Issues API, specifically to retrieve form definitions by their ID. It is useful when you need to fetch detailed metadata about a particular form definition associated with an issue or project in the iTwin platform. For example, if you have an issue's formId and want to get the full structure or schema of that form for display or processing, this node operation will provide that information.

Properties

Name Meaning
ID The unique identifier of the form definition to retrieve. This ID should come from either the "Get project form definitions" endpoint or from an issue's formId property.

Output

The node outputs JSON data representing the form definition corresponding to the provided ID. This JSON typically includes the form's schema, fields, and metadata describing the structure and content of the form. The output does not include binary data.

Dependencies

  • Requires an API authentication token credential configured in n8n to access the iTwin Issues API.
  • The node uses the iTwin OAuth2 API credential for authentication.
  • Network access to the Bentley iTwin API endpoint (https://api.bentley.com) is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent form definition ID will likely result in an error or empty response.
    • Missing or incorrect API credentials will cause authentication failures.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • Errors related to unsupported operations indicate that the requested operation is not implemented or recognized by the node.
    • Authentication errors suggest checking the API key or OAuth2 token configuration.
    • If the node fails but "Continue on Fail" is enabled, it returns an error object in the output JSON instead of stopping execution.

Links and References

Discussion