Fractal Forge icon

Fractal Forge

Retrieve data from FractalForge API

Actions5

Overview

This node integrates with the FractalForge API to retrieve data related to various entities defined in the FractalForge system. Specifically, when using the Query resource with the List operation, it fetches a list of objects for a selected entity type.

Typical use cases include:

  • Retrieving collections of data objects from FractalForge for further processing or analysis.
  • Automating workflows that require bulk data retrieval from FractalForge entities.
  • Integrating FractalForge data into other systems by listing and exporting entity records.

For example, you might use this node to list all "projects" or "tasks" stored in FractalForge, then pass that data downstream for reporting or synchronization.

Properties

Name Meaning
Entity Name or ID Select the entity type to query. You can choose from a dynamically loaded list of available entities or specify an entity ID via expression.

Output

The node outputs a JSON array where each item corresponds to an object retrieved from the specified FractalForge entity. The structure of each JSON object matches the data schema of the entity in FractalForge.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the FractalForge API.
  • Needs the API endpoint URL configured as part of the credentials.
  • The node uses HTTP requests to communicate with the FractalForge REST API.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying an unknown entity name or ID may result in errors or empty results.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "The operation \"list\" is not known!" — This indicates the operation parameter is incorrect or unsupported for the chosen resource.
    • "The resource \"query\" is not known!" — This means the resource parameter is invalid.
    • API request errors (e.g., 401 Unauthorized) typically indicate credential or permission issues.

  • Resolutions:

    • Verify that the API key and endpoint are correctly set up in the node credentials.
    • Ensure the entity name or ID exists in your FractalForge instance.
    • Check network access and firewall settings to allow outbound API requests.

Links and References

Discussion