Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

The node named "Ajax" is designed to interact with a comprehensive Ajax API, specifically versioned as indicated in the code. It supports multiple resources and operations, including the "Monitoring" resource with the operation "Get Monitoring Request From Installers." This node facilitates retrieving monitoring requests related to installers for a specified company.

Common scenarios where this node is beneficial include:

  • Fetching monitoring data or requests submitted by installers for a particular company.
  • Integrating monitoring request data into workflows for further processing, alerting, or reporting.
  • Automating retrieval of monitoring-related information from the Ajax system without manual API calls.

For example, a user might configure this node to pull all monitoring requests from installers for a given company ID, optionally paginating through results using offset and limit parameters.

Properties

Name Meaning
Company Id The unique identifier of the company for which to retrieve monitoring requests. Required.
Additional Fields Optional fields to customize the query:
- Offset Number indicating the starting point in the list of results (for pagination). Default 0.
- Limit Number indicating the maximum number of results to return. Default 10.

Output

The node outputs JSON data representing the monitoring requests retrieved from the Ajax API for the specified company. The structure typically includes details about each monitoring request made by installers, such as request identifiers, timestamps, status, and any relevant metadata.

If binary data were involved, it would be summarized here; however, based on the provided code and context, the output is purely JSON structured data.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API service.
  • Depends on the external @digital-boss/n8n-designpatterns package for response-operation resolution and execution logic.
  • Utilizes internal backend modules for state management, HTTP client communication, and operation handling.
  • The node expects proper configuration of the "ajaxApi" credential within n8n to function correctly.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key credential for the Ajax API is correctly set up and has sufficient permissions.
  • Invalid Company Id: Providing an incorrect or non-existent company ID will result in empty or error responses. Verify the company ID before running the node.
  • Pagination issues: If too many results are requested at once or offset values exceed available data, the node may return fewer results than expected. Adjust offset and limit accordingly.
  • API connectivity problems: Network issues or incorrect endpoint configurations can cause failures. Check network access and credential validity.
  • Error messages from the API: These should be inspected in the node's execution logs. Common errors might relate to authentication failure, rate limiting, or malformed requests.

Links and References

Discussion