Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with an Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Object" resource with the "Get Object Info" operation. The node fetches detailed information about a specific object within a company by using provided identifiers.

Common scenarios for this node include:

  • Retrieving metadata or status information about a particular object managed within the Ajax system.
  • Integrating Ajax object data into workflows for monitoring, reporting, or further processing.
  • Automating queries to keep external systems synchronized with Ajax-managed objects.

For example, a user might input a company ID and an object ID to retrieve the current state or configuration of that object, which can then be used downstream in the workflow.

Properties

Name Meaning
Company Id The unique identifier of the company to which the object belongs.
Object Id The unique identifier of the object whose information is to be retrieved.

These properties are required inputs when performing the "Get Object Info" operation on the "Object" resource.

Output

The node outputs JSON data containing detailed information about the specified object. This typically includes all relevant fields returned by the Ajax API for that object, such as its attributes, status, and any metadata.

If the node supports binary data output, it would represent associated files or media related to the object, but based on the provided code and context, the primary output is structured JSON data describing the object.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the @digital-boss/n8n-designpatterns package for response-operation resolution and execution logic.
  • Uses internal backend modules for HTTP communication and state management.
  • 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 issues: Connectivity problems to the Ajax API endpoint can cause request failures.
  • API version mismatch: Using an outdated or incompatible API version could lead to unexpected errors; confirm the API version matches the node's expectations.

Common error messages might include authentication failures, not found errors for the object, or timeout errors. Resolving these typically involves checking credentials, verifying input parameters, and ensuring network connectivity.

Links and References

Discussion