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 specific Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Hub" resource with an operation to temporarily mute sound indications for a company. This functionality is useful in scenarios where you want to suppress certain device alert sounds (such as offline or low battery notifications) within a company's hub environment, preventing user disturbance during maintenance or testing.

Practical examples:

  • Temporarily disabling offline device alert sounds during scheduled maintenance.
  • Muting low battery warnings for devices in a specific hub while troubleshooting hardware issues.

Properties

Name Meaning
Company Id The unique identifier of the company for which sound indications should be muted.
Hub Id The unique identifier of the hub within the company where the mute command will be applied.
Command The type of sound indication to mute. Options: MUTE_DEVICE_OFFLINE_SOUND_INDICATIONS, MUTE_DEVICE_BATTERY_LOW_SOUND_INDICATIONS.

Output

The node outputs JSON data representing the result of the executed operation. This typically includes confirmation of the mute command being applied or any relevant status information returned by the Ajax API. The exact structure depends on the API response but generally confirms success or failure of the requested action.

No binary data output is indicated in the source.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on internal modules handling HTTP requests, state management, and operation execution.
  • The node uses a bundled HTTP client to communicate with the Ajax backend service.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will prevent successful communication with the Ajax API.
    • Incorrect Company Id or Hub Id values may cause the operation to fail or target the wrong entity.
    • Selecting an unsupported command option could lead to errors or no effect.

  • Error Messages:

    • Authentication failures usually indicate invalid or expired API keys; verify and update credentials.
    • Resource not found errors suggest incorrect company or hub identifiers; double-check these inputs.
    • Operation not supported errors may occur if the command value is invalid; ensure it matches one of the provided options.

Links and References

  • No direct external links are provided in the source code.
  • For more details on the Ajax API and its commands, consult the official Ajax API documentation (not included here).

Discussion