AjaxInstall

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 Scan Fibra Device List" operation. The node facilitates retrieving lists of devices scanned via Fibra technology within a specified company and hub context.

Common scenarios for this node include:

• Integrating device management systems that use Ajax's API.
• Automating retrieval of device inventories filtered by company and hub.
• Feeding device data into workflows for monitoring, reporting, or further processing.

For example, a user might configure this node to fetch all Fibra devices associated with a particular company and hub to monitor their status or update an asset database.

Properties

These properties are required inputs when using the "Get Scan Fibra Device List" operation under the "Device" resource.

Output

The node outputs JSON data representing the list of Fibra devices scanned for the specified company and hub. The exact structure depends on the API response but typically includes device details such as identifiers, statuses, and other relevant metadata.

If the node supports binary data output, it would relate to any device-related files or media returned by the API; however, based on the provided code and operation, the primary output is JSON-formatted device information.

Dependencies

• Requires an API key credential for authenticating with the Ajax API.
• Depends on the external Ajax API service endpoint.
• Uses internal helper classes for HTTP requests, state management, and operation resolution.
• No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

• Missing or invalid credentials: Ensure the API key credential is correctly configured and has sufficient permissions.
• Invalid Company Id or Hub Id: Verify that the provided IDs exist and are correct; otherwise, the API may return empty results or errors.
• Network issues: Connectivity problems to the Ajax API endpoint can cause request failures.
• API changes: If the Ajax API updates its endpoints or response formats, the node may require updates to maintain compatibility.

Common error messages might include authentication failures, resource not found, or bad request errors due to missing parameters. Resolving these involves checking credentials, input values, and network connectivity.

Links and References

• Ajax API Documentation (general reference for Ajax API)
• n8n documentation on creating custom nodes
• Relevant API client libraries or SDKs if available from Ajax