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 by the bundled version file). It supports multiple resources and operations, including the "Rapid Response Unit" resource with the "Get All Rapid Response" operation. The node acts as a generic client to consume various Ajax API endpoints, making it useful for automating workflows that require fetching or manipulating data from Ajax services.

A common scenario for this node is retrieving all rapid response units associated with a company, which can be used in security monitoring, incident management, or alerting systems. For example, a user might want to fetch all rapid response teams linked to a specific company ID to display their status or dispatch information within an internal dashboard.

Properties

Name Meaning
Company Id The unique identifier of the company whose rapid response units you want to retrieve.

Note: The property "Company Id" is required when using the "findCompanyReceivers" operation under the "rapidResponseUnit" resource.

Output

The node outputs JSON data representing the results returned by the Ajax API for the requested operation. Specifically, for the "Get All Rapid Response" operation, the output JSON will contain an array or collection of rapid response unit objects related to the specified company.

If the API returns binary data (not evident from the provided code), it would be included in the binary output field, typically representing files or media associated with the response.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the HttpClient class for making HTTP requests to the backend Ajax API.
  • Utilizes internal modules for state management and operation resolution/execution.
  • The node expects the user to configure the appropriate credentials in n8n before execution.

Troubleshooting

  • Missing or invalid API credentials: The node requires valid authentication credentials to access the Ajax API. Ensure the API key or token is correctly configured.
  • Incorrect Company Id: Providing an invalid or non-existent company ID may result in empty responses or errors from the API.
  • Network issues: Connectivity problems between n8n and the Ajax API endpoint can cause request failures.
  • Unsupported operation/resource combination: Selecting an unsupported operation or resource may lead to errors; verify that "rapidResponseUnit" and "findCompanyReceivers" are valid selections.
  • API rate limits or permissions: The Ajax API might enforce rate limits or require specific permissions; check your API account settings if requests fail unexpectedly.

Links and References

Discussion