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 supports multiple resources and operations, including managing employee access to objects within a company. Specifically, the "Create Employee Access" operation under the "Object" resource allows users to grant an employee certain permissions on a specified object.

Common scenarios for this node include automating access control workflows in a security or asset management system where employees need controlled access to various objects or resources. For example, a security manager could use this node to programmatically assign read or read-write permissions to employees for specific devices or areas within a company.

Properties

Name Meaning
Company Id The unique identifier of the company where the object and employee exist. Required to specify the context of the access being granted.
Object Id The unique identifier of the object to which access is being granted.
Employee Id The unique identifier of the employee who will receive the access permissions.
Permissions The level of access granted to the employee. Options are: READ (view-only access) or READ_WRITE (view and modify access).
Additional Fields Optional extra parameters:
- Version: A numeric version indicator.
- Expiration Date: A timestamp (milliseconds since epoch) when READ_WRITE permissions expire and revert to READ. Applicable only if permissions are READ_WRITE.

Output

The node outputs JSON data representing the result of the create employee access operation. This typically includes confirmation details such as the created access record, status, or any relevant metadata returned by the Ajax API.

If binary data were involved, it would be summarized here, but based on the provided code and properties, the output is purely JSON structured data related to access control.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Invalid IDs: Errors may occur if companyId, objectId, or employeeId do not correspond to existing entities in the Ajax system.
  • Permission value issues: Only READ and READ_WRITE are valid; other values will cause errors.
  • Expiration date misuse: If expirationDate is set when permissions are not READ_WRITE, it might be ignored or cause unexpected behavior.
  • API connectivity problems: Network issues or incorrect endpoint configuration can lead to request failures.

To resolve these, verify all input parameters, check API credentials, and ensure network connectivity.

Links and References

Discussion