Fractal Forge icon

Fractal Forge

Retrieve data from FractalForge API

Actions9

Overview

This node integrates with the FractalForge API to perform various operations on entities and commands within the FractalForge system. Specifically, for the Command - Update operation, it updates an existing object in a specified entity collection by sending a PUT request with JSON data representing the updated fields.

Typical use cases include:

  • Modifying properties of an existing command object in a FractalForge entity collection.
  • Automating updates to configuration or metadata stored as objects in FractalForge.
  • Integrating FractalForge command updates into larger workflows where command objects need to be programmatically changed based on external triggers or data.

For example, you might update a command's parameters or status after receiving new input from another system, ensuring your FractalForge data stays current without manual intervention.

Properties

Name Meaning
Entity Collection Name or ID (collection) Selects the target entity collection to update the object in. You can choose from a list loaded dynamically or specify an ID via expression.
Object ID (objectId) The unique identifier of the object within the selected collection that you want to update.
JSON (jsonBody) A JSON object containing the fields and values to update on the specified object. This represents the new state or changes to apply.

Output

The node outputs an array of JSON objects representing the response from the FractalForge API after the update operation. Each output item corresponds to one input item processed.

  • The json field contains the updated object data returned by the API.
  • No binary data is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the FractalForge API.
  • The node uses the configured API endpoint and authorization token to send HTTP requests.
  • The "Entity Collection Name or ID" options are dynamically loaded from the FractalForge API endpoint /system/commands-events-per-entity.

Troubleshooting

  • Invalid Object ID: If the provided object ID does not exist in the specified collection, the API will likely return an error. Verify the ID is correct and exists.
  • Malformed JSON Body: Ensure the JSON provided in the jsonBody property is valid and matches the expected schema for the object being updated.
  • Authentication Errors: If the API key is missing, invalid, or expired, the node will fail with an authentication error. Check the API credentials configuration.
  • Unknown Operation or Resource: The node throws errors if unsupported operations or resources are specified. Confirm that "command" resource and "update" operation are selected.
  • API Endpoint Issues: Network problems or incorrect API endpoint URLs will cause request failures. Verify connectivity and endpoint correctness.

Links and References

Discussion