Fractal Forge icon

Fractal Forge

Retrieve data from FractalForge API

Overview

This node integrates with the FractalForge API to perform various operations on entity collections and objects within those collections. Specifically, for the Command resource with the Custom (Collection) operation, it allows users to execute custom commands on an entire collection of entities.

Typical use cases include:

  • Triggering specialized backend processes or workflows defined as custom commands on a collection.
  • Extending standard CRUD operations with bespoke commands tailored to specific business logic.
  • Automating batch operations or complex actions that are exposed via custom commands in the FractalForge system.

For example, if you have a collection of "invoices," you might run a custom command like "archive" on the entire collection to archive all invoices meeting certain criteria.

Properties

Name Meaning
Entity Collection Name or ID (collection) Selects the target entity collection by name or ID. The list is dynamically loaded from FractalForge.
Custom Command (customCommand) The name of the custom command to execute on the selected collection. This must be a valid command defined in FractalForge.

Output

The node outputs JSON data representing the response from the FractalForge API after executing the custom command on the collection. The structure depends on the API's response but generally includes details about the result of the command execution, such as success status, affected records, or any returned data.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the FractalForge API.
  • The node expects the API endpoint URL and API key to be configured in the credentials.
  • The node dynamically loads available entity collections from the FractalForge API to populate the collection selection dropdown.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying a non-existent collection or custom command will result in API errors.
    • Network connectivity problems can prevent communication with the FractalForge API.
  • Error messages:

    • "The operation \"custom_collection_command\" is not known!" — indicates an unsupported operation was selected; ensure the correct operation is chosen.
    • API errors returned from FractalForge are wrapped and surfaced by the node; check the error message for details.
  • Resolutions:

    • Verify API credentials and permissions.
    • Confirm the collection and custom command names exist and are spelled correctly.
    • Check network access and proxy settings if applicable.

Links and References

Discussion