Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the code). It supports multiple resources and operations, including monitoring-related functionalities. Specifically, for the resource Monitoring and operation Get Counter Of Monitoring Request From Installers, the node retrieves a count of monitoring requests made by installers for a given company.

This node is beneficial in scenarios where users need to programmatically access monitoring data from the Ajax system, such as tracking how many monitoring requests installers have generated within a company. For example, a security management platform could use this node to fetch real-time statistics on installer activity to generate reports or trigger alerts.

Properties

Name Meaning
Company Id The unique identifier of the company for which the count of monitoring requests is retrieved. This is a required string input.

Output

The node outputs JSON data containing the result of the requested operation. For the "Get Counter Of Monitoring Request From Installers" operation, the output JSON will include the count of monitoring requests associated with the specified company ID.

The exact structure of the JSON output depends on the Ajax API response but typically includes fields representing the count and possibly metadata about the request.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential to authenticate with the Ajax API.
  • Depends on the external Ajax API service being available and accessible.
  • Uses internal helper classes for HTTP communication, state management, and operation resolution/execution.
  • No additional environment variables are explicitly required beyond the API authentication credential.

Troubleshooting

  • Authentication errors: If the node fails due to invalid credentials, verify that the provided API key or token is correct and has sufficient permissions.
  • Invalid Company Id: Ensure the "Company Id" property is correctly set and corresponds to an existing company in the Ajax system.
  • Network issues: Failures connecting to the Ajax API may be caused by network problems or API downtime; check connectivity and service status.
  • Unexpected API responses: If the output JSON does not contain expected fields, confirm that the API version matches and that the operation is supported for the given resource.

Links and References

Discussion