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 managing objects. Specifically, for the "Object" resource and the "Cancel Object Deletion" operation, the node allows users to cancel a previously initiated deletion of an object within the Ajax system.

Common scenarios where this node is beneficial include:

  • Reversing accidental deletions of objects in the Ajax platform.
  • Managing lifecycle states of objects programmatically.
  • Integrating Ajax object management into automated workflows.

For example, if a user accidentally triggers deletion of a security device or configuration object, this node can be used to cancel that deletion before it completes, preserving the object.

Properties

Name Meaning
Company Id The unique identifier of the company under which the object exists.
Object Id The unique identifier of the object whose deletion is to be canceled.

Output

The node outputs JSON data representing the result of the cancellation request. This typically includes confirmation of the cancellation status and any relevant metadata about the object or operation outcome.

If the node supports binary data output, it would relate to any files or media associated with the object, but based on the provided code and properties, the primary output is JSON structured response data from the Ajax API.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on internal backend modules for HTTP communication, state management, and operation execution.
  • Needs proper configuration of the "ajaxApi" credential within n8n to function correctly.

Troubleshooting

  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
  • Invalid IDs: Verify that both Company Id and Object Id are correct and correspond to existing entities in the Ajax system.
  • Operation not permitted: Some objects may not allow cancellation of deletion depending on their state or user permissions.
  • Network issues: Confirm network connectivity to the Ajax API endpoint.

Common error messages might include unauthorized access, not found errors for invalid IDs, or operation forbidden errors. Resolving these involves checking credentials, input values, and user permissions.

Links and References

Discussion