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 backend Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Network" resource with an operation to "Update General GSM Settings." The node facilitates updating GSM-related network settings such as disabling ICMP before connecting, allowing virtual operators, and enabling roaming for a specified user and hub.

Common scenarios where this node is beneficial include:

  • Managing network configurations programmatically within an automation workflow.
  • Updating GSM settings for devices or hubs remotely without manual intervention.
  • Integrating network management tasks into broader business processes.

For example, a user can automate the process of enabling roaming on a device's GSM module when it moves out of its primary coverage area by setting the "Roaming Enabled" property to true.

Properties

Name Meaning
User Id Identifier of the user whose network GSM settings are being updated.
Hub Id Identifier of the hub associated with the GSM settings to update.
Disable Icmp Before Connecting Boolean flag to disable ICMP (Internet Control Message Protocol) checks before connecting.
Virtual Operator Allowed Boolean flag indicating whether virtual operators are permitted in the GSM settings.
Roaming Enabled Boolean flag to enable or disable roaming capability on the GSM network.

Output

The node outputs JSON data representing the result of the GSM settings update operation. This typically includes confirmation of the updated settings or any relevant response from the backend API indicating success or failure.

If the node supports binary data output, it would relate to any raw responses or files returned by the API, but based on the provided code and context, the primary output is structured JSON reflecting the operation's outcome.

Dependencies

  • Requires an API key credential for authenticating with the Ajax backend API.
  • Depends on the @digital-boss/n8n-designpatterns package for operation resolution and execution patterns.
  • Uses internal modules for HTTP client communication and state management.
  • The node expects proper configuration of the Ajax API credentials within n8n.

Troubleshooting

  • Authentication Errors: If the API key credential is missing or invalid, the node will fail to authenticate. Ensure that the correct API key is configured.
  • Invalid Property Values: Providing incorrect types or missing required properties like User Id or Hub Id will cause errors. Validate input parameters before execution.
  • API Connectivity Issues: Network problems or incorrect endpoint configurations may lead to request failures. Verify network access and API availability.
  • Operation Not Supported: If the specified resource-operation combination is not implemented or recognized, the node may throw an error. Confirm that "Network" resource and "Update General GSM Settings" operation are supported.

Links and References

Discussion