AjaxInstall

Overview

This node, named "Ajax," is designed to interact with a specific Ajax API (version indicated in the code). It supports multiple resources and operations, including managing objects and their notes. The particular operation "Delete Object Note" under the "Object" resource allows users to delete a note associated with a given object within a specified company.

Common scenarios for this node include automating the management of notes attached to objects in a system that uses the Ajax API. For example, if an organization wants to programmatically remove outdated or irrelevant notes from objects as part of a cleanup or update workflow, this node would be beneficial.

Practical example:

• A user wants to delete a specific note from an object identified by its ID within a company. By providing the Company Id, Object Id, and Note Id, the node will perform the deletion via the Ajax API.

Properties

Output

The node outputs data in the json field representing the result of the delete operation. Typically, this would include confirmation of successful deletion or details about any error encountered. Since the node interacts with an API, the output structure depends on the API response but generally confirms whether the note was successfully removed.

If the node supports binary data output, it is not evident from the provided code snippet; thus, the primary output is JSON data reflecting the operation's outcome.

Dependencies

• Requires an API key credential for authenticating with the Ajax API.
• Depends on the external Ajax API service being available and accessible.
• Uses internal helper classes for HTTP communication, state management, and operation resolution/execution.
• No additional environment variables are explicitly required beyond the API authentication credential.

Troubleshooting

• Authentication errors: If the API key credential is missing or invalid, the node will fail to authenticate. Ensure the correct API key is configured.
• Invalid IDs: Providing incorrect Company Id, Object Id, or Note Id may result in errors such as "not found" or "invalid parameter." Verify all IDs before execution.
• Network issues: Connectivity problems with the Ajax API endpoint can cause timeouts or failures. Check network access and API availability.
• API changes: If the Ajax API version changes or deprecates endpoints, the node might fail. Keep the node and API versions compatible.

Links and References

• Ajax API Documentation (general reference for the Ajax API)
• n8n documentation on creating custom nodes for further customization guidance