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 Resource "Receiver" and Operation "Find All Company Receivers," it retrieves all receiver entities associated with a specified company. This functionality is useful in scenarios where you need to list or manage all receivers linked to a particular company within the Ajax system.

Practical examples include:

  • Fetching all security device receivers installed at a company's premises.
  • Aggregating receiver data for reporting or monitoring purposes.
  • Synchronizing receiver information with other systems or dashboards.

Properties

Name Meaning
Company Id The unique identifier of the company for which all receivers should be retrieved. This is a required string input.

Output

The node outputs JSON data representing the collection of receivers found for the specified company. Each item in the output corresponds to a receiver entity with its associated details as provided by the Ajax API.

If the node supports binary data output (not explicitly shown in the provided code), it would typically represent attachments or media related to receivers, but this is not evident here.

Dependencies

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

Troubleshooting

  • Missing or invalid Company Id: Since "Company Id" is required, omitting it or providing an incorrect value will likely cause errors or empty results.
  • Authentication failures: If the API key credential is missing, expired, or invalid, the node will fail to connect to the Ajax API.
  • API connectivity issues: Network problems or incorrect endpoint configurations can lead to request failures.
  • Unexpected API responses: Changes in the Ajax API or permission restrictions might cause errors; ensure the API user has sufficient rights.

To resolve these issues:

  • Verify that the "Company Id" is correctly set and valid.
  • Check that the API key credential is properly configured and active.
  • Ensure network connectivity and correct API endpoint settings.
  • Review API permissions and update them if necessary.

Links and References

Discussion