Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

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 "RRU Code" resource with an operation to update the RRU Code password. The node facilitates sending requests to the backend API to perform actions such as updating passwords securely.

A common use case for this node is managing access control systems where RRU Codes represent remote units or devices requiring password updates. For example, a security administrator could automate the process of changing device passwords across multiple hubs and companies to maintain security compliance.

Properties

Name Meaning
Company Id Identifier of the company owning the RRU Code; required to specify the context.
Hub Id Identifier of the hub associated with the RRU Code; required to target the correct hub.
Rru Code Id Identifier of the specific RRU Code to update; required to select the exact device.
New Password The new password to set for the RRU Code; must be a 4-6 digit code as per description.

Output

The node outputs JSON data representing the result of the update operation on the RRU Code password. This typically includes confirmation of success or failure, and may contain updated details of the RRU Code entity after the password change.

No binary data output is indicated or expected from this node.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external Ajax backend service accessible via HTTP.
  • The node uses internal helper classes for state management, HTTP communication, and operation resolution/execution.
  • No additional environment variables are explicitly required beyond the API authentication credential.

Troubleshooting

  • Authentication errors: If the API key credential is missing or invalid, the node will fail to authenticate. Ensure the correct API key is configured.
  • Invalid input values: The "New Password" must be 4-6 digits; providing an incorrect format may cause the API to reject the request.
  • Resource or Operation mismatch: Selecting unsupported combinations of resource and operation will lead to errors. Confirm that "rruCode" resource and "updateRruCodePassword" operation are selected together.
  • Network issues: Failures in connecting to the backend API can occur due to network problems or incorrect endpoint configuration.
  • API errors: The backend might return errors if the specified companyId, hubId, or rruCodeId do not exist or the user lacks permissions.

Links and References

Discussion