Actions16
Overview
This node interacts with the Atomic BI API to manage various resources, including Playbooks. Specifically, for the Playbooks - Delete operation, it allows users to delete Playbooks based on specified filters and criteria. This is useful in scenarios where you want to programmatically remove outdated or irrelevant Playbooks from your system.
Practical examples include:
- Automatically deleting Playbooks that meet certain conditions (e.g., created before a specific date).
- Cleaning up Playbooks associated with a particular user or space.
- Removing Playbooks matching custom filter criteria to maintain data hygiene.
Properties
| Name | Meaning |
|---|---|
| Select | List of fields to select from the Playbooks when performing the operation. If left empty, all fields are selected. Options include: Id, User Id, Space Id, Name, Instructions, Rules, Created At, Updated At, Mail, Chat, Browser, Linkedin, Objective, Bypass Agent. |
| Filter | Filters to apply to select which Playbooks to delete. Each filter consists of a field (standard or custom), an operator (Equals, Like, ILike, Contains), and a value. Multiple filters can be combined. |
| Offset | Starting offset of Playbooks to consider for deletion. Useful for pagination or skipping initial records. |
| Limit | Maximum number of Playbooks to delete. Limits the scope of the operation to avoid mass deletions. Maximum allowed is 1000. |
| Order By | Field by which to order the Playbooks before deletion. Same options as Select fields. |
| Order Direction | Direction of ordering: Ascending or Descending. Only applicable if "Order By" is set. |
| Additional Select | Advanced option to specify additional select fields for Playbooks using comma-separated values. Allows fetching extra fields beyond those listed in Select. |
Output
The output JSON contains the result of the delete operation. When deleting Playbooks, the node returns the deleted Playbook objects matching the criteria, each represented as a JSON object with the selected fields.
If the limit is set to 1, the output is a single JSON object wrapped in an array; otherwise, it outputs an array of JSON objects representing each deleted Playbook.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the Atomic BI API.
- The node depends on the Atomic BI API endpoint URL configured in credentials.
- No other external services or environment variables are required.
Troubleshooting
- Invalid operation error: If the operation parameter is not "GET" (which seems to be the only supported operation in the code snippet), the node throws an error indicating an invalid operation. Ensure the operation is correctly set to "Delete" or the appropriate supported operation.
- API authentication errors: If the API key or base URL is incorrect or missing, the node will fail to authenticate. Verify credentials are properly configured.
- Filter syntax issues: Incorrectly formatted filters may cause the API to reject requests or return no results. Double-check filter fields, operators, and values.
- Limit and offset misuse: Setting very high limits or offsets without understanding the dataset size might lead to unexpected behavior or performance issues.
- Empty selection fields: Leaving the Select property empty defaults to selecting all fields, which might impact performance if many fields exist.
Links and References
- Atomic BI API Documentation (Replace with actual URL)
- n8n Documentation on Creating Custom Nodes
- General guide on Using Filters in API Requests (Replace with relevant resource)