TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage various resources, including reports. Specifically, for the Report - Delete operation, it deletes a report resource identified by its unique ID. This is useful in scenarios where you need to programmatically remove outdated or unnecessary reports from your TeleFlow system to maintain data hygiene or comply with data retention policies.

Practical example: Automatically deleting reports older than a certain date as part of a cleanup workflow.

Properties

Name Meaning
ID The unique identifier of the report resource to delete. This is required.
Fields Optional field-value pairs to include in the request for more specific queries (not used in delete but available generally).

Output

The output JSON contains the response from the TeleFlow API after attempting to delete the specified report. Typically, this will be an object indicating success or failure of the deletion operation. No binary data is output by this node.

Example output structure:

{
  "success": true,
  "message": "Report deleted successfully"
}

or in case of error:

{
  "error": "Error message describing what went wrong"
}

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The base URL for the TeleFlow API must be configured in the node credentials.
  • The node uses HTTP requests to communicate with the TeleFlow REST API.

Troubleshooting

  • Missing ID Error: If the ID property is not provided, the node throws an error stating that the ID is required for the delete operation. Ensure the ID is correctly set.
  • API Errors: If the API returns an error (e.g., report not found, permission denied), the node will throw an error unless "Continue On Fail" is enabled, in which case the error message is returned in the output JSON.
  • Network Issues: Connectivity problems or incorrect base URL configuration can cause request failures. Verify network access and credential settings.
  • Permission Issues: Ensure the API key has sufficient permissions to delete reports.

Links and References

Discussion