Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

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 the "Object" resource with the operation "Get Responsible Persons By Object Id." The node fetches data related to responsible persons associated with a specific object within a company.

Common scenarios for this node include:

  • Retrieving contact or management information for a particular object (e.g., a device, location, or asset) identified by its ID.
  • Integrating Ajax system data into workflows that require knowledge of who is responsible for certain objects.
  • Automating notifications or actions based on responsible persons linked to objects.

Practical example:

  • A security monitoring workflow could use this node to get the list of responsible persons for a triggered alarm object, then notify those individuals automatically.

Properties

Name Meaning
Company Id The unique identifier of the company to which the object belongs.
Object Id The unique identifier of the object for which responsible persons are being retrieved.

Output

The node outputs JSON data containing details about the responsible persons associated with the specified object. The exact structure depends on the Ajax API response but typically includes fields such as person identifiers, names, roles, and contact information.

If the node supports binary data output, it would represent any associated files or media related to the responsible persons, but this is not explicitly indicated in the provided code.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external @digital-boss/n8n-designpatterns package for resolving and executing resource-operation logic.
  • Uses internal backend modules for state management, HTTP client communication, and operation methods.
  • The node expects proper configuration of the Ajax API credentials within n8n.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key credential for the Ajax API 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 or API errors: Check network connectivity and the status of the Ajax API service.
  • Operation not supported: If the resource or operation parameters are incorrect or unsupported, the node may fail to resolve the operation method.

Common error messages might include authentication failures, resource not found, or permission denied. Resolving these usually involves checking credentials, input parameters, and API access rights.

Links and References

  • Ajax API Documentation (general reference for the Ajax API)
  • n8n documentation on creating custom nodes
  • @digital-boss/n8n-designpatterns package repository (if publicly available) for understanding resource-operation patterns

Discussion