Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the code). It provides a flexible interface to perform various operations on multiple resources within the Ajax ecosystem. Specifically, for the Resource "Object" and Operation "Get Employee Access," the node retrieves access information related to an employee for a particular object within a company.

Common scenarios where this node is beneficial include:

  • Managing security or access control systems by querying which employees have access to specific objects or areas.
  • Integrating Ajax system data into workflows that require employee access verification.
  • Automating audits or reports on employee permissions within a company's infrastructure.

Practical example:

  • A security manager wants to verify if a certain employee has access rights to a secured room (object) in the company. By providing the company ID, object ID, and employee ID, this node fetches the relevant access details from the Ajax API.

Properties

Name Meaning
Company Id The unique identifier of the company within which the object and employee exist.
Object Id The unique identifier of the object (e.g., device, room, or asset) whose access is queried.
Employee Id The unique identifier of the employee whose access rights to the object are being retrieved.

Output

The node outputs JSON data containing the employee's access information related to the specified object within the company. This typically includes details such as access permissions, status, and possibly timestamps or metadata about the access rights.

If the node supports binary data output, it would represent any associated files or attachments related to the access record; however, based on the provided code and context, the primary output is structured JSON data reflecting the access details.

Dependencies

  • Requires an active connection to the Ajax API via an API key credential (referred generically as "an API key credential").
  • The node depends on internal backend modules for state management, HTTP client communication, and operation resolution.
  • No additional external services beyond the Ajax API are required.
  • Proper configuration of the API authentication token in n8n credentials is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect or non-existent Company Id, Object Id, or Employee Id may result in empty responses or errors indicating resource not found.
    • Network connectivity issues can prevent successful API calls.

  • Error Messages and Resolutions:

    • Authentication failed: Verify that the API key credential is correctly set up and has sufficient permissions.
    • Resource not found: Double-check the IDs provided for company, object, and employee to ensure they exist in the Ajax system.
    • Timeout or network error: Ensure stable internet connection and that the Ajax API endpoint is reachable.

Links and References

Discussion