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 network-related actions. Specifically, for the Network resource and the operation "Enable/disable GSM Network Channel For Company," it allows users to enable or disable the GSM network channel for a specified company and hub.

Common scenarios where this node is beneficial include:

  • Managing network configurations programmatically within an automation workflow.
  • Enabling or disabling GSM channels for companies dynamically based on business logic.
  • Integrating network management tasks into broader operational processes without manual intervention.

For example, a user could automate turning off the GSM network channel for a company during maintenance windows or enable it when new hardware is deployed.

Properties

Name Meaning
Company Id The unique identifier of the company for which the GSM network channel state will be changed.
Hub Id The unique identifier of the hub associated with the company where the GSM channel state applies.
State The desired state of the GSM network channel; options are "ON" to enable or "OFF" to disable.

Output

The node outputs JSON data representing the result of the requested operation. This typically includes confirmation of the action taken, such as success status and any relevant metadata returned by the backend API regarding the GSM network channel state change.

If the node handles binary data, it would relate to raw responses or files from the Ajax API, but based on the provided code and context, the output is primarily 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 response-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 to function correctly.

Troubleshooting

  • Authentication errors: If the node fails due to authentication issues, verify that the API key credential is correctly configured and has sufficient permissions.
  • Invalid parameters: Ensure that the Company Id and Hub Id are valid and correspond to existing entities in the backend system.
  • Network connectivity: Failures in reaching the Ajax API endpoint may cause timeouts or connection errors; check network access and proxy settings if applicable.
  • Operation not supported: If the operation or resource is misspelled or unsupported, the node may throw errors related to unknown operations; confirm correct parameter values.
  • API version mismatch: Since the node uses a specific API version, ensure the backend supports the version expected by the node.

Links and References

Discussion