Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the code). It supports multiple resources and operations, including the "RRU Code" resource with an "Update RRU Code" operation. The node facilitates updating properties of an RRU Code entity within the Ajax system, such as permissions for groups and additional configurable fields.

Typical use cases include:

  • Managing security or alarm system configurations by updating RRU Codes.
  • Automating permission changes for user groups related to specific RRU Codes.
  • Adjusting operational parameters like delays and action periods on RRU Codes programmatically.

For example, a security administrator could automate the update of group permissions on an RRU Code when organizational roles change, ensuring that only authorized groups have ARM or DISARM capabilities.

Properties

Name Meaning
Company Id Identifier of the company owning the RRU Code.
Hub Id Identifier of the hub associated with the RRU Code.
Rru Code Id Unique identifier of the RRU Code to be updated.
Groups Permissions A collection allowing multiple entries, each specifying:
- Group Id: Identifier of the group.
- Group Permissions: Permissions assigned to the group; options are "ARM" and "DISARM".
Additional Fields Optional additional settings for the RRU Code, including:
- Name: Custom name field.
- Index: Numeric index value.
- Arming Permissions: Multiple selectable permissions from "ARM", "DISARM", and "NIGHT_MODE".
- Enabled: Boolean flag indicating if the RRU Code is enabled.
- Post Alarm Activation Delay Seconds: Number specifying delay after alarm activation.
- Action Period Minutes: Number specifying the duration of the action period in minutes.

Output

The node outputs data in JSON format representing the result of the update operation on the RRU Code. This typically includes confirmation of the updated fields and possibly the updated state of the RRU Code entity as returned by the Ajax API.

If the node supports binary data output, it would relate to any binary content returned by the Ajax API, but based on the provided code and context, the primary output is structured JSON data reflecting the update response.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external Ajax API service being accessible and properly configured.
  • Uses internal helper classes and methods for HTTP communication and operation resolution, bundled within the node's implementation.

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 in n8n credentials.
  • Invalid Identifiers: Providing incorrect or non-existent Company Id, Hub Id, or Rru Code Id will cause the update operation to fail. Verify these IDs before execution.
  • Permission Issues: Attempting to assign unsupported permissions or malformed group permissions may result in errors. Use only the allowed permission values ("ARM", "DISARM", "NIGHT_MODE").
  • API Connectivity: Network issues or Ajax API downtime can cause request failures. Check network connectivity and API status.
  • Data Validation: Ensure numeric fields like "Index", "Post Alarm Activation Delay Seconds", and "Action Period Minutes" are valid numbers to avoid validation errors.

Links and References

Discussion