AjaxInstall

Overview

This node, named "Ajax," is designed to interact with a specific Ajax API (version indicated in the node description). It allows users to perform various operations on different resources exposed by the Ajax system. In particular, for the Resource "Object" and Operation "Get Object maintenance Data," the node fetches maintenance-related information for a specified object within a company.

Common scenarios where this node is beneficial include:

• Retrieving maintenance status or history of physical or logical objects managed in the Ajax system.
• Integrating Ajax object maintenance data into workflows for monitoring, reporting, or triggering alerts.
• Automating maintenance scheduling or verification processes based on up-to-date object data.

Example use case:

• A facility management workflow that automatically checks the maintenance status of equipment (objects) before scheduling inspections or repairs.

Properties

Output

The node outputs JSON data containing the maintenance information of the specified object. This typically includes fields such as maintenance schedules, status, last maintenance date, upcoming maintenance tasks, or any other relevant metadata provided by the Ajax API for the object.

If the node supports binary data output, it would represent related files or documents associated with the object's maintenance (e.g., reports or images), but this is not explicitly indicated in the provided code snippet.

Dependencies

• Requires an API key credential for authenticating with the Ajax API.
• Depends on the external Ajax API service being accessible and responsive.
• Uses internal helper classes for HTTP communication, state management, and operation resolution.
• No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

• Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
• Invalid Company Id or Object Id: Verify that the provided IDs exist and are correct; otherwise, the API may return errors or empty results.
• Network issues: Check connectivity to the Ajax API endpoint.
• Unexpected response structure: If the API changes, the node might fail to parse the maintenance data properly.
• Missing required parameters: Both Company Id and Object Id must be provided; missing these will cause execution failure.

Links and References

• Ajax API Documentation (general reference for the Ajax platform)
• n8n documentation on creating custom nodes
• Relevant version info: Ajax API v. referenced in node description (exact version from bundled source: p.version)