Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

Overview

The node named "Ajax" is designed to interact with the Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Hub" resource with the "Cancel Device Search" operation. This particular operation allows users to cancel an ongoing device search on a specified hub.

Common scenarios for this node include managing Ajax security systems programmatically within n8n workflows, such as controlling hubs, devices, and user-related actions. For example, if a device search was started on a hub but needs to be stopped due to a change in configuration or error, this operation can be used to cancel that search.

Properties

Name Meaning
User Id The identifier of the user who owns or manages the hub where the device search is running.
Hub Id The identifier of the hub on which the device search should be cancelled.

These properties are required inputs when performing the "Cancel Device Search" operation on the "Hub" resource.

Output

The node outputs JSON data representing the result of the API call to cancel the device search. The exact structure depends on the Ajax API response but typically includes status information about the cancellation request.

If the node supports binary data output, it would relate to any files or media returned by the API, but based on the provided code and operation, the output is primarily JSON.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on internal modules for HTTP communication, state management, and operation resolution/execution.
  • The node uses the HttpClient class to perform HTTP requests to the Ajax backend.
  • Requires proper configuration of the API credentials in n8n to function correctly.

Troubleshooting

  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
  • Invalid User Id or Hub Id: Verify that the provided identifiers exist and are correct; otherwise, the API may return errors indicating not found or unauthorized access.
  • Network issues: Check connectivity to the Ajax API endpoint.
  • Operation not supported: If the node version or API version changes, some operations might become deprecated or unavailable.

Common error messages will likely come from the Ajax API responses and should be handled accordingly in the workflow, possibly by inspecting the output JSON for error codes or messages.

Links and References

Discussion