Fractal Forge icon

Fractal Forge

Retrieve data from FractalForge API

Overview

This node integrates with the FractalForge API to perform various data retrieval and manipulation operations on entity collections. It supports querying and commanding resources, allowing users to list, get, create, update, delete, or run custom commands and queries on objects or collections within FractalForge.

Typical use cases include:

  • Fetching lists of entities or specific objects from a collection.
  • Creating or updating objects in an entity collection.
  • Deleting objects by ID.
  • Executing custom queries or commands tailored to specific business logic or workflows defined in FractalForge.

For example, a user might list all customers in a "Customers" collection, update a particular customer's details by their object ID, or run a custom query to retrieve aggregated data.

Properties

Name Meaning
Entity Collection Name or ID (collection) Selects the target entity collection by name or ID. Options are dynamically loaded from FractalForge.
Object ID (objectId) The unique identifier of the object within the collection. Required for operations targeting a single object such as get, update, delete, or custom object commands/queries.
Custom Query (customQuery) The name of a custom query to execute on a collection or object. Used only for custom query operations.

Output

The node outputs JSON data representing the response from the FractalForge API. The structure depends on the operation performed:

  • For list operations, it returns an array of objects representing the entities.
  • For get operations, it returns a single object.
  • For create, update, and delete operations, it returns the API's confirmation or resulting object.
  • For custom commands and queries, it returns the data as provided by the API, which can vary depending on the custom logic.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the FractalForge API.
  • The node configuration must include the API endpoint URL and the API key.
  • The node dynamically loads available entity collections from the API to populate options.

Troubleshooting

  • Common Issues:

    • Invalid or missing API key will cause authentication failures.
    • Incorrect collection names or IDs may result in "not found" errors.
    • Providing an invalid object ID for operations that require it will cause errors.
    • Using unsupported operations or resource types will throw explicit errors.
  • Error Messages:

    • "The operation \"<operation>\" is not known!" indicates an unsupported operation was selected.
    • "The resource \"<resource>\" is not known!" means the resource type is invalid.
    • API errors returned from FractalForge are wrapped and presented as node API errors; these often indicate issues like permission denied, invalid parameters, or server errors.
  • Resolution Tips:

    • Verify API credentials and endpoint correctness.
    • Ensure the collection and object IDs exist and are correctly formatted.
    • Use the dynamic dropdowns where possible to avoid typos.
    • Check the FractalForge API documentation for valid custom command/query names.

Links and References

Discussion