AjaxInstall

Overview

This node, named "Ajax," is designed to interact with a specific Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Object" resource with an operation to delete media by its ID. The node facilitates making authenticated HTTP requests to the backend Ajax API, allowing users to perform CRUD-like actions on various entities managed by the API.

A common use case for this node is automating management tasks within the Ajax system, such as deleting media files associated with objects programmatically. For example, if you have an object representing a device or entity in your system and want to remove a specific media item linked to it, this node can execute that deletion via the API.

Properties

These properties are required inputs when using the "Delete Object Media By Id" operation on the "Object" resource.

Output

The node outputs data in JSON format representing the result of the delete operation. Typically, this would include confirmation of successful deletion or error details if the operation failed.

If the node handles binary data, it is not evident from the provided code snippet; thus, the output primarily consists of JSON responses from the Ajax API.

Dependencies

• Requires an API key credential for authenticating with the Ajax API.
• Depends on internal modules for HTTP communication, state management, and operation resolution/execution.
• The node uses a bundled HTTP client to send requests to the Ajax backend.
• No additional external services beyond the Ajax API itself are needed.

Troubleshooting

• Authentication Errors: If the API key credential is missing or invalid, the node will fail to authenticate. Ensure the correct API key is configured in the node credentials.
• Invalid IDs: Providing incorrect or non-existent Company Id, Object Id, or Media Id will likely cause the API to return errors indicating the resource was not found.
• Network Issues: Connectivity problems to the Ajax API endpoint will prevent execution. Verify network access and endpoint availability.
• Operation Not Supported: Using unsupported combinations of resource and operation may cause fallback or failure. Confirm that "deleteObjectMediaById" is supported for the "Object" resource.

Links and References

• Ajax API Documentation (general reference for the Ajax platform)
• n8n Documentation on Creating Custom Nodes
• HTTP Client usage patterns in n8n nodes (internal reference)