Fractal Forge icon

Fractal Forge

Retrieve data from FractalForge API

Actions9

Overview

This node integrates with the FractalForge API to retrieve data from various entity collections. Specifically, the Query - List operation fetches a list of objects from a selected entity collection within FractalForge. This is useful when you want to pull multiple records or entries from a specific dataset managed by FractalForge.

Common scenarios include:

  • Retrieving all items in a product catalog.
  • Listing user accounts or profiles stored in FractalForge.
  • Fetching logs or event records for analysis.

For example, if you have an entity collection named "orders," using this node with the List operation will return all order objects available in that collection.

Properties

Name Meaning
Entity Collection Name or ID Selects the target entity collection from which to list objects. You can choose from a dropdown list of available collections or specify a collection ID via an expression.

Output

The output is a JSON array where each element represents an object retrieved from the specified entity collection. Each object contains the fields and values as defined by the FractalForge entity schema.

  • The json field holds the data of each listed object.
  • No binary data output is produced by this operation.

Example output snippet (simplified):

[
  {
    "id": "123",
    "name": "Sample Object",
    "createdAt": "2024-01-01T12:00:00Z",
    ...
  },
  {
    "id": "124",
    "name": "Another Object",
    "createdAt": "2024-01-02T08:30:00Z",
    ...
  }
]

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 uses HTTP requests to communicate with the FractalForge REST API.

Troubleshooting

  • Invalid or missing API credentials: Ensure that the API key and endpoint are correctly configured in the node credentials.
  • Unknown collection name or ID: Verify that the collection exists in your FractalForge instance and that the name or ID is correct.
  • API request failures: Network issues or incorrect permissions may cause errors. Check connectivity and API access rights.
  • Error message "The operation 'list' is not known!": This indicates a misconfiguration of the operation parameter; ensure "List" is selected under the Query resource.
  • If the node throws an error related to authorization, confirm that the API key has sufficient privileges to read from the specified collection.

Links and References

Discussion