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). Specifically for the Network resource and the Enable/disable Ethernet Network Channel For Company operation, it allows users to enable or disable the Ethernet network channel for a specified company hub. This can be useful in scenarios where network administrators need to remotely control network connectivity settings for different company hubs, such as turning on or off Ethernet channels for maintenance, troubleshooting, or operational adjustments.

Practical examples:

  • Enabling the Ethernet channel for a company's hub after scheduled downtime.
  • Disabling the Ethernet channel temporarily due to detected network issues or security concerns.

Properties

Name Meaning
Company Id The unique identifier of the company for which the Ethernet network channel state will be changed.
Hub Id The unique identifier of the specific hub within the company whose Ethernet channel state is targeted.
State The desired state of the Ethernet network channel; options are ON (enable) or OFF (disable).

Output

The node outputs JSON data representing the result of the operation performed on the Ajax API. This typically includes confirmation of the requested state change for the Ethernet network channel, possibly including status codes or messages returned by the API.

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

Dependencies

  • Requires an active connection to the Ajax API via an API key credential (referred generically as "an API key credential").
  • The node depends on internal helper classes for HTTP communication, state management, and operation resolution/execution.
  • No additional external services beyond the Ajax API are required.
  • Proper configuration of the API credentials in n8n is necessary for successful execution.

Troubleshooting

  • Common Issues:

    • Invalid or missing Company Id or Hub Id parameters may cause the API call to fail.
    • Incorrect API credentials or expired tokens will prevent successful authentication.
    • Network connectivity issues between n8n and the Ajax API endpoint can cause timeouts or errors.
    • Providing an invalid state value outside of ON or OFF will likely result in validation errors.
  • Error Messages:

    • Authentication errors indicating invalid credentials should prompt users to verify and update their API key.
    • Validation errors related to missing or malformed parameters require checking the input fields for correctness.
    • API response errors might include messages about the company or hub not being found, which means verifying the IDs is necessary.

Links and References

Discussion