Actions9
- Command Actions
- Query Actions
Overview
This node integrates with the FractalForge API to perform various operations on entity collections and objects within those collections. It supports both "Command" and "Query" resources, allowing users to create, update, delete, retrieve, list, or execute custom commands and queries on entities.
Common scenarios include:
- Creating or updating objects in a specific entity collection.
- Deleting objects by their ID.
- Retrieving single objects or listing multiple objects from a collection.
- Executing custom commands or queries tailored to specific business logic or API extensions.
Practical examples:
- Automating data synchronization by creating or updating objects in FractalForge based on external triggers.
- Fetching detailed information about an object for reporting or further processing.
- Running custom commands on objects to trigger workflows or state changes not covered by standard CRUD operations.
Properties
| Name | Meaning |
|---|---|
Entity Collection Name or ID (collection) |
Selects the target entity collection by name or ID. You can choose from a loaded list or specify an ID via expression. |
Object ID (objectId) |
The unique identifier of the object within the collection. Required for operations that act on a specific object (update, delete, get, custom object commands/queries). |
Custom Command (customCommand) |
The name of a custom command to execute on either a collection or an individual object. Used only for "Command" resource with custom operations. |
Custom Query (customQuery) |
The name of a custom query to execute on either a collection or an individual object. Used only for "Query" resource with custom operations. |
JSON (jsonBody) |
A JSON object representing the data payload for create or update operations on objects. |
Output
The node outputs an array of JSON objects corresponding to the results of each executed operation. Each item in the output contains the response data returned by the FractalForge API for the respective input item.
- For retrieval and list operations, the output includes the requested object(s) data.
- For create, update, and delete operations, the output reflects the API's confirmation or resulting object state.
- For custom commands and queries, the output contains whatever data the API returns for those calls.
The node does not output binary data.
Dependencies
- Requires an API key credential for authenticating with the FractalForge API.
- The API endpoint URL and API key must be configured in the node credentials.
- The node dynamically loads available entity collections from the API to populate options.
Troubleshooting
- Unknown Operation Error: If you select an unsupported operation for the chosen resource, the node throws an error indicating the operation is unknown. Ensure the operation matches the resource type ("command" or "query").
- Missing Object ID: Operations targeting a specific object require a valid
objectId. Omitting this or providing an invalid ID will cause errors. - API Request Failures: Network issues, invalid credentials, or incorrect API endpoint configuration can cause request failures. Check your API key and endpoint settings.
- Invalid JSON Body: For create and update commands, ensure the JSON body is well-formed and matches the expected schema of the target entity.
To resolve errors:
- Verify all required parameters are set correctly.
- Confirm API credentials and endpoint are valid.
- Use expressions carefully when specifying IDs or commands.
- Review the FractalForge API documentation for correct usage of custom commands and queries.