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 by the bundled version info). It supports multiple resources and operations, including the "Hub" resource with the operation "Create An Object For Locked Hub." The node facilitates creating objects within a locked hub environment by sending appropriate requests to the backend API.

Common scenarios for this node include:

  • Automating the creation of new entities or objects inside a secured hub system.
  • Integrating external systems with the Ajax platform to programmatically manage hubs.
  • Streamlining workflows that require dynamic object creation in locked hubs based on input parameters.

For example, a user might use this node to create a new device or asset record inside a specific locked hub by providing the company ID, hub ID, registration number, and name.

Properties

Name Meaning
Company Id Identifier of the company owning or related to the hub where the object will be created.
Hub Id Identifier of the locked hub where the object should be created.
Registration Number A unique registration number associated with the object being created.
Name The name assigned to the new object within the locked hub.

These properties are required inputs when performing the "Create An Object For Locked Hub" operation under the "Hub" resource.

Output

The node outputs JSON data representing the result of the creation operation. This typically includes details about the newly created object such as its identifiers, status, and any metadata returned by the Ajax API.

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

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 modules for HTTP client communication and state management.
  • The node expects proper configuration of the Ajax API credentials within n8n.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Missing required parameters: All four properties (Company Id, Hub Id, Registration Number, Name) must be provided; missing any will likely cause request failures.
  • API connectivity issues: Network problems or incorrect endpoint configurations can lead to timeouts or connection errors.
  • Invalid input values: Providing invalid IDs or registration numbers may cause the API to reject the request.

Error messages from the node will generally reflect these issues, so verifying credentials, input completeness, and network access are first steps in troubleshooting.

Links and References

Discussion