Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

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 bindings between hubs and receivers. The particular operation "Delete Hub To Receiver Binding" under the "Receiver" resource allows users to remove an existing association between a hub and a receiver within a specified company.

Common scenarios for this node include:

  • Managing IoT or security devices where hubs and receivers are linked.
  • Automating device configuration by programmatically deleting obsolete or incorrect bindings.
  • Integrating with backend systems that require dynamic updates of device relationships.

For example, if a security system administrator wants to unbind a receiver device from a hub due to hardware replacement or reconfiguration, this node can be used to perform that action automatically within a workflow.

Properties

Name Meaning
Company Id The unique identifier of the company owning the devices. Required to specify the scope.
Receiver Id The unique identifier of the receiver device whose binding to a hub will be deleted.
Hub Id The unique identifier of the hub from which the receiver binding will be removed.

Output

The node outputs JSON data representing the result of the delete operation. This typically includes confirmation of success or details about the deletion status. The exact structure depends on the Ajax API response but generally confirms whether the binding was successfully removed.

No binary data output is indicated or expected for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the HttpClient class for making HTTP requests to the backend service.
  • Utilizes internal state management and operation resolution classes to handle request execution and response processing.
  • The node expects proper configuration of the API credentials within n8n to function correctly.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key credential is correctly configured and has sufficient permissions to delete bindings.
  • Invalid IDs: Providing incorrect or non-existent Company Id, Receiver Id, or Hub Id will likely cause errors or no effect. Verify these identifiers before running the node.
  • Network issues: Connectivity problems with the Ajax API endpoint may cause timeouts or failures.
  • API errors: If the backend returns an error (e.g., binding not found), the node will propagate this. Check the error message for details and confirm the binding exists before attempting deletion.

Links and References

Discussion