Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

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 the "Receiver" resource with the "Get Receiver To Hub Binding" operation. The node fetches data related to how a receiver device is bound or linked to a hub within a company’s system.

Common scenarios for this node include:

  • Retrieving the association details between a receiver device and a hub in a security or monitoring system.
  • Integrating Ajax system data into workflows that require knowledge of device-to-hub bindings.
  • Automating audits or reports on device configurations within a company.

For example, a user might want to verify which hub a particular receiver is connected to by providing the company ID, receiver ID, and hub ID, then use this information downstream in their automation.

Properties

Name Meaning
Company Id The unique identifier of the company owning the receiver and hub.
Receiver Id The unique identifier of the receiver device whose binding to a hub is being queried.
Hub Id The unique identifier of the hub to which the receiver is expected to be bound.

These properties are required inputs when performing the "Get Receiver To Hub Binding" operation under the "Receiver" resource.

Output

The node outputs JSON data representing the binding information between the specified receiver and hub. This typically includes details such as binding status, configuration parameters, timestamps, or other metadata describing the relationship.

If the node supports binary data output, it would relate to any raw data fetched from the Ajax API, but based on the provided code and context, the primary output is structured JSON reflecting the receiver-to-hub binding.

Dependencies

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

Troubleshooting

  • Missing or invalid credentials: Ensure that a valid API authentication token is configured in the node credentials; otherwise, API calls will fail.
  • Incorrect IDs: Providing wrong or non-existent companyId, receiverId, or hubId will likely result in errors or empty responses. Verify these identifiers before execution.
  • Network issues: Connectivity problems to the Ajax API endpoint can cause timeouts or request failures.
  • API version mismatch: The node is tied to a specific API version; if the backend API changes, the node may need updating.

Common error messages might include authentication failures, resource not found, or invalid parameter errors. Resolving them involves checking credentials, verifying input parameters, and ensuring network connectivity.

Links and References

Discussion