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 RRU Codes. The "Delete RRU Code" operation allows users to delete a particular RRU Code by specifying identifiers such as Company Id, Hub Id, and RRU Code Id.

Common scenarios for this node include automating management tasks within an Ajax-based system, such as removing obsolete or incorrect RRU Codes from a company's hub setup. For example, if a device represented by an RRU Code is decommissioned, this node can be used to programmatically remove its record.

Properties

Name Meaning
Company Id The unique identifier of the company owning the RRU Code.
Hub Id The unique identifier of the hub where the RRU Code is registered.
Rru Code Id The unique identifier of the RRU Code to be deleted.

All three properties are required inputs for the "Delete RRU Code" operation.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this would include confirmation of deletion or any relevant status messages returned by the Ajax API. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on internal modules for HTTP communication, state management, and operation resolution.
  • The node uses a bundled HTTP client to send requests to the backend Ajax API.
  • No additional external services beyond the Ajax API itself are indicated.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Invalid identifiers: Verify that Company Id, Hub Id, and RRU Code Id are correct and correspond to existing entities in the Ajax system.
  • Network issues: Check connectivity to the Ajax API endpoint.
  • API errors: If the API returns errors (e.g., resource not found), confirm that the RRU Code exists and is deletable.
  • Missing required parameters: All three input properties must be provided; missing any will likely cause the node to fail.

Links and References

  • Refer to the official Ajax API documentation for details on the RRU Code resource and delete operation.
  • Consult n8n community forums or documentation for guidance on setting up API credentials and using custom nodes.

Discussion