Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

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 managing employee access to objects within a company. The "Delete Employee Access" operation under the "Object" resource allows users to revoke an employee's access rights to a particular object.

Common scenarios for this node include automating access control management in security or facility management systems, where employees' permissions need to be dynamically updated based on role changes, project assignments, or security policies.

For example, when an employee leaves a project or company, this node can be used to programmatically remove their access to sensitive equipment or rooms, ensuring compliance and security without manual intervention.

Properties

Name Meaning
Company Id The unique identifier of the company where the object and employee exist.
Object Id The unique identifier of the object (e.g., device, room, or asset) from which access is revoked.
Employee Id The unique identifier of the employee whose access to the specified object will be deleted.

Output

The node outputs JSON data representing the result of the delete operation. This typically includes confirmation of success or failure, and may contain details such as status codes or messages returned by the Ajax API.

If the operation involves binary data (not indicated here), it would represent related files or media; however, for this operation, output is expected to be purely JSON-based.

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 requests, state management, and operation resolution.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Authentication errors: Ensure that the provided API key credential is valid and has sufficient permissions to perform delete operations.
  • Invalid IDs: Errors may occur if Company Id, Object Id, or Employee Id do not correspond to existing entities in the system. Verify these identifiers before execution.
  • Network issues: Connectivity problems with the Ajax API endpoint can cause timeouts or failures. Check network settings and API availability.
  • Permission denied: The authenticated user might lack rights to delete employee access. Confirm user roles and privileges.
  • Unexpected API responses: If the API returns unexpected data or error formats, verify that the node version matches the API version and that the API has not changed.

Links and References

Discussion