iTwin Issues icon

iTwin Issues

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

Overview

This node operation deletes a specific form definition from the iTwin Issues system. It is useful when you want to remove outdated or incorrect form definitions that are no longer needed in your project. For example, if a form template used for issue reporting has been deprecated or replaced, this operation allows you to clean up by deleting the old form definition.

Properties

Name Meaning
ID The unique identifier of the form definition to delete. This ID should be obtained from the "Get iTwin form definitions" endpoint or from a form data instance's "formId" property.

Output

The output JSON will typically contain the response from the API after attempting to delete the specified form definition. This may include confirmation of deletion or error information if the deletion failed. The node does not output binary data.

Dependencies

  • Requires an API key credential for authentication with the iTwin platform.
  • Needs network access to the Bentley iTwin API endpoints.
  • The node depends on the iTwinOAuth2Api credential configured in n8n for authorization.
  • Uses internal shared utilities for making authenticated API requests.

Troubleshooting

  • Common issues:
    • Providing an invalid or non-existent form definition ID will result in an error.
    • Lack of proper API credentials or expired tokens can cause authentication failures.
    • Network connectivity problems may prevent the request from reaching the API.
  • Error messages:
    • Errors related to unsupported operations indicate that the operation name might be incorrect or not implemented.
    • API errors returned from the server (e.g., 404 Not Found) usually mean the form definition ID does not exist.
  • Resolutions:
    • Verify the form definition ID is correct and was retrieved from a valid source.
    • Ensure the API credentials are correctly set up and have sufficient permissions.
    • Check network connectivity and retry the operation.

Links and References

Discussion