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 "Device" resource with the "Get Devices List For Company" operation. The node fetches device data associated with a given company and hub, optionally enriching the returned information.

Common scenarios for this node include:

  • Retrieving all devices linked to a particular company and hub for inventory or monitoring purposes.
  • Integrating device lists into workflows that automate asset management or reporting.
  • Enriching device data to obtain more detailed information for analysis or display.

Example use case: A user wants to get a list of all security devices installed in a company's hubs to monitor their status or perform maintenance scheduling.

Properties

Name Meaning
Company Id The unique identifier of the company whose devices are to be listed.
Hub Id The unique identifier of the hub within the company to filter devices by.
Additional Fields Optional fields to modify the request; currently supports:
- Enrich: boolean flag to request enriched device data.

Output

The node outputs JSON data representing the list of devices retrieved from the Ajax API for the specified company and hub. Each item in the output typically contains device details such as identifiers, status, and other relevant attributes. If the "Enrich" option is enabled, additional detailed information about each device may be included.

The node does not explicitly handle binary data output.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external Ajax API service being available and accessible.
  • Uses internal helper classes for HTTP requests, state management, and operation resolution.

Troubleshooting

  • Missing or invalid credentials: Ensure that a valid API authentication token is configured in the node's credentials.
  • Invalid Company Id or Hub Id: Verify that the provided IDs exist and are correctly formatted.
  • Network or API errors: Check network connectivity and the availability of the Ajax API service.
  • Empty or unexpected responses: Confirm that the company and hub have devices registered; if using enrichment, verify that the API supports it for the requested devices.

Common error messages might relate to authentication failures, resource not found, or malformed requests. Resolving these usually involves checking credentials, input parameters, and API status.

Links and References

Discussion