Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the code). Specifically, for the Ring Management resource and the Manage Rings Connections operation, it allows users to manage connections between rings within a specified company and hub. This includes adding new ring connections or removing existing ones by specifying pairs of main and slave bus IDs.

Common scenarios where this node is beneficial include:

  • Automating the configuration of ring connections in a security or monitoring system managed via the Ajax platform.
  • Bulk updating ring connections when reorganizing or expanding networked devices.
  • Integrating ring management into broader workflows that require dynamic control over device interconnections.

Practical example:

  • A user wants to add two new ring connections and remove one old connection for a specific hub in their company’s Ajax system. They provide the company ID, hub ID, and specify the rings to add and remove using main and slave bus IDs. The node processes these changes through the Ajax API.

Properties

Name Meaning
Company Id The unique identifier of the company under which the rings are managed.
Hub Id The unique identifier of the hub where ring connections will be managed.
Additional Fields Optional fields to specify rings to add or remove:
- Rings To Add List of ring connections to add, each defined by a pair of numbers: Main Bus Id and Slave Bus Id.
- Rings To Remove List of ring connections to remove, each defined similarly by Main Bus Id and Slave Bus Id.

Output

The node outputs JSON data representing the result of the ring connections management operation. This typically includes confirmation of added and removed ring connections or any relevant status messages returned by the Ajax API.

If binary data were involved, it would represent files or media related to the operation, but in this case, the output is purely JSON reflecting the API response.

Dependencies

  • Requires an active connection to the Ajax API via an API key credential configured in n8n.
  • Depends on internal backend modules for HTTP communication, state management, and operation execution.
  • No additional external services beyond the Ajax API are required.

Troubleshooting

  • Missing or invalid credentials: Ensure the API key credential for the Ajax API is correctly set up and has sufficient permissions.
  • Invalid Company Id or Hub Id: Verify that the provided IDs exist and are correct; otherwise, the API may return errors indicating not found or unauthorized access.
  • Incorrect ring connection data: The main and slave bus IDs must be valid numbers corresponding to actual devices or buses; invalid values may cause the API to reject the request.
  • API connectivity issues: Network problems or incorrect endpoint configurations can lead to timeouts or failed requests.
  • Error messages from the API: Typically include details about what went wrong (e.g., invalid parameters, permission denied). Review the message and adjust input accordingly.

Links and References

  • Ajax API Documentation (general reference for the Ajax platform API)
  • n8n documentation on creating custom nodes
  • General info on ring management concepts in networked security systems (vendor-specific docs may apply)

Discussion