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 objects. Specifically, for the "Object" resource and the "Delete An Object" operation, the node allows users to delete an object identified by its ID within a specified company context.

Common scenarios where this node is beneficial include:

  • Automating the removal of obsolete or unwanted objects from a system.
  • Integrating with workflows that require cleanup or management of objects based on external triggers.
  • Managing data lifecycle by programmatically deleting objects after certain conditions are met.

For example, a user might configure this node to delete a device or entity from their Ajax system when it is decommissioned or no longer needed.

Properties

Name Meaning
Company Id The unique identifier of the company under which the object exists.
Object Id The unique identifier of the object to be deleted.
Additional Fields Optional parameters affecting deletion behavior:
- Immediately Boolean flag indicating whether the object should be deleted immediately.
- Days To Wait Number of days to wait before performing the deletion if not immediate.

Output

The node outputs JSON data representing the result of the delete operation. This typically includes confirmation of deletion or relevant status information returned by the Ajax API. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the @digital-boss/n8n-designpatterns package for operation resolution and execution logic.
  • Uses internal backend modules for HTTP communication and state management.
  • The node must be configured with valid credentials to access the Ajax API.

Troubleshooting

  • Authentication Errors: If the API key credential is missing or invalid, the node will fail to authenticate. Ensure the correct API key is provided.
  • Invalid IDs: Providing incorrect or non-existent Company Id or Object Id will likely cause errors or unsuccessful deletion attempts. Verify these IDs before running the node.
  • Network Issues: Connectivity problems with the Ajax API endpoint can cause timeouts or failures. Check network settings and API availability.
  • Immediate vs Delayed Deletion: Misconfiguration of the "Immediately" flag and "Days To Wait" may lead to unexpected delays or premature deletions. Confirm these settings align with intended behavior.

Links and References

(Note: The above links are general references; specific API endpoints and parameters should be verified against the official Ajax API documentation.)

Discussion