Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with an Ajax API (version indicated in the description). It supports multiple resources and operations, including the "Object" resource with the "Get List Of Objects" operation. The node fetches data from the Ajax backend by making HTTP requests through a client wrapper.

A common use case for this node is to retrieve lists of objects related to a company and hub within the Ajax system, optionally enriching the returned data. For example, a user might want to get all security devices or sensors associated with a particular company and hub, possibly with additional enriched information for each object.

Properties

Name Meaning
Company Id The identifier of the company whose objects are to be retrieved.
Hub Id The identifier of the hub within the company to filter the objects.
Enrich A string parameter indicating whether to enrich the returned objects with extra data.
Additional Fields - Enrich A boolean option to specify if enrichment should be applied to the objects list.

Note: The "Enrich" property appears both as a required string parameter and as an optional boolean inside "Additional Fields." This may reflect different ways to control enrichment behavior.

Output

The node outputs JSON data representing the list of objects retrieved from the Ajax API. Each item in the output corresponds to an object associated with the specified company and hub. If enrichment is enabled, the output objects include additional detailed information.

If the node supports binary data output, it would typically represent files or media related to the objects, but based on the provided code and properties, the primary output is JSON data.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Uses internal modules for HTTP communication, state management, and operation resolution.
  • No external environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key credential is correctly configured in n8n; otherwise, authentication will fail.
  • Invalid Company Id or Hub Id: Providing incorrect identifiers will result in empty results or errors from the API.
  • Enrichment issues: If enrichment is requested but not supported or improperly configured, the node might return incomplete data or error responses.
  • Network or API errors: Connectivity problems or API downtime can cause execution failures; check network access and API status.

Common error messages likely relate to authentication failures, invalid parameters, or HTTP request errors. Reviewing the node's input parameters and credentials usually resolves these issues.

Links and References

Discussion