Actions31
- Option Set Actions
- Public Query Actions
- Record Actions
- Role Actions
- Workflow Actions
- Worksheet Actions
Record → Batch Delete
AI-generatedOverview
The node interacts with the HAP (Hyper Application Platform) API to perform batch deletion of multiple records within a specified worksheet. This operation is useful when you need to remove several rows from a worksheet at once, either by soft deleting them (making them recoverable) or permanently deleting them (irreversible removal).
Common scenarios include:
- Cleaning up outdated or irrelevant data entries in bulk.
- Automating data maintenance workflows where multiple records must be deleted based on certain criteria.
- Integrating with other systems that trigger batch deletions after processing.
For example, if you have a worksheet tracking customer orders and want to delete all canceled orders in one go, this node can batch delete those rows efficiently.
Properties
| Name | Meaning |
|---|---|
| Worksheet ID | The unique identifier of the worksheet containing the records to delete. |
| Row IDs | An array of row record IDs specifying which records to delete. Example: ["row_id_1", "row_id_2"] |
| Permanent | Boolean flag indicating whether to permanently delete the records (true) or perform a soft delete (false). Permanent deletion cannot be undone. |
| Trigger Workflow | Boolean flag to determine whether to trigger a workflow after the batch delete operation completes. |
Output
The node outputs JSON data representing the result of the batch delete operation. Typically, this includes confirmation of which records were deleted and the status of the operation. The exact structure depends on the API response but generally confirms success or failure per record.
This node does not output binary data.
Dependencies
- Requires an API key credential for authenticating with the HAP API.
- The node expects proper configuration of the HAP API credentials within n8n.
- Network access to the HAP API endpoint is necessary.
Troubleshooting
Issue: Deletion fails or only some records are deleted.
- Cause: Invalid or missing worksheet ID or row IDs.
- Resolution: Verify that the worksheet ID and all row IDs are correct and exist in the target worksheet.
Issue: Permanent deletion attempted but recovery needed.
- Cause: Permanent deletion is irreversible.
- Resolution: Use soft delete option (
Permanentset to false) if you want the ability to recover deleted records.
Issue: Workflow not triggered after deletion.
- Cause:
Trigger Workflowproperty set to false. - Resolution: Set
Trigger Workflowto true if subsequent workflow execution is required.
- Cause:
Issue: Authentication errors.
- Cause: Missing or invalid API key credential.
- Resolution: Ensure the API key credential is correctly configured and has sufficient permissions.