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 the "Installation" resource with an operation to "Send Request For Delete Own Installation Company." The node facilitates sending API requests to manage installation-related data, such as requesting deletion of a company associated with an installation.

A common use case for this node is automating administrative tasks related to installations within a system that uses the Ajax API. For example, it can be used to programmatically request the deletion of a company from the installation records without manual intervention, streamlining workflows in environments managing multiple installations and companies.

Properties

These properties are required inputs when performing the "Send Request For Delete Own Installation Company" operation under the "Installation" resource.

Output

The node outputs JSON data representing the response from the Ajax API after executing the requested operation. This typically includes confirmation of the deletion request or error details if the request fails.

If the node supports binary data output, it would represent any files or media returned by the API, but based on the provided code and operation, the output is primarily JSON structured data.

Dependencies

• Requires an API key credential for authenticating with the Ajax API.
• Depends on the external @digital-boss/n8n-designpatterns package for handling resource-operation resolution and execution logic.
• Uses internal backend modules for state management, HTTP client communication, and operation methods.
• The node expects proper configuration of the API credentials within n8n to successfully authenticate and send requests.

Troubleshooting

• Missing or invalid credentials: Ensure that the API key credential is correctly configured and has sufficient permissions to perform deletion requests.
• Invalid Company Id or Hub Id: Verify that the provided identifiers exist and are correct; otherwise, the API may return errors indicating not found or unauthorized access.
• API connectivity issues: Network problems or incorrect endpoint configurations can cause request failures. Check network settings and API availability.
• Error responses from API: The node will relay error messages from the Ajax API. Review these messages to understand issues like permission denials or invalid parameters.

Links and References

• Ajax API Documentation (general reference for Ajax API usage)
• n8n documentation on Creating Custom Nodes
• @digital-boss/n8n-designpatterns package repository or documentation (if available) for understanding resource-operation patterns