Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node is designed to update a "Receiver" entity for a specified company within an Ajax API system. It allows users to modify various attributes of a receiver, such as its identification details, operational state, protocol settings, connection information, and code override rules.

Common scenarios where this node would be beneficial include:

  • Managing security or monitoring systems where receivers represent hardware or software endpoints.
  • Updating configuration parameters of receivers when organizational changes occur.
  • Automating maintenance tasks that require bulk updates to receiver properties across multiple companies.

Practical example:

  • A security administrator wants to update the ping interval and enable auto-approval of hub bindings for a receiver associated with a particular company. This node can be used to programmatically apply those changes without manual intervention.

Properties

Name Meaning
Company Id The unique identifier of the company to which the receiver belongs.
Receiver Id The unique identifier of the receiver to be updated.
Version The version number of the receiver record, likely used for concurrency control or optimistic locking.
Name The name assigned to the receiver.
Hub To Cms Ping Period Minutes Interval in minutes specifying how often the receiver should ping the CMS (Central Management System).
Use Hub Id As Account Number Boolean flag indicating whether the hub ID should be used as the account number.
Auto Approve Hub Binding Boolean flag that enables automatic approval of hub binding; applicable only if "Use Hub Id As Account Number" is true. Otherwise, it must be false.
State Indicates whether the receiver is enabled or disabled. Possible values: ACTIVE, INACTIVE.
Protocol Collection containing protocol-related settings. Currently supports specifying the protocol type as a string.
Connections List of connection objects bound to the receiver. Each connection includes:
- Host (string)
- Port (number)
- Primary (boolean): indicates if this connection is the primary one. One or two connections allowed.
Code Override Rules Collection of rules to override or ignore specific event codes. Contains two types of rules:
- Override: Defines replacement values for certain event tags.
- Ignore: Specifies event tags to be ignored.

Output

The node outputs JSON data representing the updated receiver object after applying the changes. This output typically includes all the updated fields such as company ID, receiver ID, version, name, ping period, flags, state, protocol details, connections, and code override rules.

If the node supports binary data output, it is not indicated here; thus, the output is primarily structured JSON reflecting the receiver's updated state.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API service.
  • Depends on the Ajax API backend to perform the update operation.
  • No additional environment variables or external services are explicitly required beyond the authenticated API access.

Troubleshooting

  • Version Mismatch Errors: If the provided version does not match the current version on the server, the update may fail due to concurrency control. Ensure you use the latest version number.
  • Invalid Identifiers: Providing incorrect or non-existent company or receiver IDs will result in errors. Verify IDs before execution.
  • Protocol or Connection Validation: Improperly formatted protocol types or connection details (e.g., invalid hostnames or ports) might cause failures.
  • Auto Approve Hub Binding Constraint: Setting "Auto Approve Hub Binding" to true while "Use Hub Id As Account Number" is false will likely cause validation errors.
  • Missing Required Fields: All required fields must be provided; missing mandatory inputs like companyId, receiverId, version, name, etc., will prevent successful execution.

Links and References

Discussion