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 the "Object" resource with the "Get Employee Access List" operation. The primary function of this operation is to retrieve a list of employees who have access permissions related to a specific object within a company.

Common scenarios for using this node include:

• Managing security or access control systems where you need to audit or verify which employees have access to certain physical or logical objects.
• Integrating employee access data into workflows for compliance, reporting, or automated notifications.
• Synchronizing access lists with other systems such as HR or facility management software.

For example, a security manager could use this node to fetch all employees authorized to enter a particular room or area identified by an Object Id within their company's system.

Properties

These properties are required inputs when performing the "Get Employee Access List" operation on the "Object" resource.

Output

The node outputs JSON data containing the employee access list associated with the specified object. This typically includes details about each employee who has access rights, such as employee identifiers, names, roles, or access levels, depending on the API's response structure.

If the node supports binary data output (not explicitly shown in the provided code), it would likely relate to attachments or documents linked to access records, but no such indication is present here.

Dependencies

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

Troubleshooting

• Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions to access employee and object data.
• Invalid or missing parameters: Both "Company Id" and "Object Id" must be provided; missing or incorrect values will cause the API call to fail.
• API connectivity issues: Network problems or API downtime can result in request failures; verify network access and API status.
• Unexpected response format: If the API changes its response schema, the node might not parse the output correctly; check for updates or contact support.

Links and References

• Ajax API Documentation (general reference for the Ajax platform)
• n8n documentation on creating custom nodes
• Relevant API authentication setup guides within your n8n instance for securely managing credentials