Fractal Forge icon

Fractal Forge

Retrieve data from FractalForge API

Actions9

Overview

This node integrates with the FractalForge API to perform various operations on entity collections and objects within those collections. Specifically, for the Command - Delete operation, it deletes an object identified by its ID from a specified entity collection.

Common scenarios where this node is useful include:

  • Automating cleanup tasks by deleting obsolete or unwanted objects in your FractalForge data.
  • Integrating deletion workflows triggered by external events or conditions.
  • Managing lifecycle of entities programmatically without manual intervention.

For example, you might use this node to delete a user record or a transaction entry from a specific collection when certain criteria are met elsewhere in your workflow.

Properties

Name Meaning
Entity Collection Name or ID (collection) Selects the target entity collection from which the object will be deleted. You can choose from a list of available collections or specify an ID using an expression.
Object ID (objectId) The unique identifier of the object to delete within the selected collection. This is required to specify exactly which object should be removed.

Output

The node outputs JSON data representing the response from the FractalForge API after attempting the delete operation. Typically, this will confirm whether the deletion was successful or provide details about the deleted object.

If the API returns any binary data (not typical for delete operations), it would be included accordingly, but this node primarily deals with JSON responses.

Dependencies

  • Requires an API key credential for authenticating with the FractalForge API.
  • The node configuration must include the API endpoint URL and a valid API authentication token.
  • The node uses HTTP requests to communicate with the FractalForge REST API.

Troubleshooting

  • Common issues:

    • Invalid or missing Object ID: Ensure the objectId property is correctly set and corresponds to an existing object in the specified collection.
    • Incorrect collection name or ID: Verify that the collection property matches a valid entity collection accessible via your API credentials.
    • Authentication errors: Confirm that the API key credential is valid and has sufficient permissions to delete objects.
    • Network or connectivity problems: Check your network connection and API endpoint availability.

  • Error messages:

    • "The operation "delete" is not known!": This indicates an unsupported operation was requested; ensure the operation parameter is set to "Delete".
    • API errors returned from FractalForge (e.g., 404 Not Found, 401 Unauthorized) will be surfaced as node errors. Review the error message for details and verify your inputs and credentials.
    • If the node throws a generic request failure, inspect the API endpoint URL and credentials.

Links and References

Discussion