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 receivers for companies. The particular operation "Delete Receiver For Given Company" allows users to delete a receiver entity associated with a specified company.

Common scenarios where this node is beneficial include:

  • Managing IoT or security devices linked to companies.
  • Automating cleanup or maintenance tasks by removing obsolete or decommissioned receivers.
  • Integrating with backend systems that require programmatic control over device assignments.

For example, a security management system could use this node to automatically remove a receiver device from a company's profile when it is no longer in use.

Properties

Name Meaning
Company Id The unique identifier of the company from which the receiver should be deleted.
Receiver Id The unique identifier of the receiver device to be deleted for the given company.

Output

The node outputs JSON data representing the result of the delete operation. This typically includes confirmation of deletion or relevant status information returned by the Ajax API. There is no indication of binary data output.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external Ajax API service to perform operations.
  • Uses internal helper classes for HTTP communication, state management, and resource-operation resolution.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Invalid IDs: Verify that both the Company Id and Receiver Id are correct and exist in the system.
  • Network issues: Check connectivity to the Ajax API endpoint.
  • API errors: If the API returns errors (e.g., receiver not found), review the error message for details and confirm the resource exists.

Links and References

  • Refer to the official Ajax API documentation for detailed information about receiver management endpoints.
  • Consult n8n documentation on setting up API credentials and using custom nodes.

Discussion