AjaxInstall

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 creating notes on objects. Specifically, for the "Object" resource and the "Create Object Note" operation, the node allows users to add a note to an object within a specified company context.

Common scenarios where this node is beneficial include:

• Adding contextual notes or comments to objects managed in the Ajax system.
• Automating documentation or annotation of objects during workflows.
• Integrating Ajax object note creation into larger automation pipelines.

For example, a user might automate adding maintenance notes to equipment objects after inspections or log incident details as notes attached to security devices.

Properties

Output

The node outputs JSON data representing the result of the create note operation. This typically includes confirmation details such as the created note's ID, timestamps, and any metadata returned by the Ajax API.

If the node supports binary data output, it would represent associated files or attachments related to the note, but based on the provided code and properties, the primary output is structured JSON data about the created note.

Dependencies

• Requires an API key credential for authenticating with the Ajax API.
• Depends on the external Ajax API service being available and reachable.
• Uses internal helper classes for HTTP communication, state management, 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 Data: Missing required fields like Company Id, Object Id, Text, or Expiration Date will cause errors. Validate all required inputs before execution.
• API Connectivity Issues: Network problems or Ajax API downtime can cause request failures. Verify network connectivity and API status.
• Date Format Issues: Expiration Date and other date fields must be provided as milliseconds since epoch. Incorrect formats may lead to unexpected behavior.
• Permission Denied: The authenticated user may lack permissions to create notes on the specified object or company. Check user roles and access rights.

Links and References

• Ajax API Documentation (hypothetical link; replace with actual)
• n8n Documentation on Creating Custom Nodes
• General info on Unix Epoch Time