TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage various resources, including "Provision". Specifically, the Delete operation for the "Provision" resource allows users to remove a provision record by its unique identifier. This is useful in scenarios where obsolete or incorrect provisioning data needs to be cleaned up from the system.

Practical examples include:

  • Automatically deleting provisioning entries that are no longer valid.
  • Cleaning up test or temporary provisions after deployment.
  • Managing lifecycle of provisioning records as part of a larger automation workflow.

Properties

Name Meaning
ID The unique identifier of the provision 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 for other operations).

Output

The output JSON contains the response from the TeleFlow API after attempting to delete the specified provision. Typically, this will be an object indicating success or failure of the deletion operation. The exact structure depends on the API's response but generally confirms whether the provision was deleted.

No binary data output is produced by this operation.

Example output JSON might look like:

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

or in case of error:

{
  "error": "Provision not found"
}

Dependencies

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

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 you provide a valid provision ID.
  • API Errors: If the provision does not exist or cannot be deleted, the API may return an error message which will be passed through the node output. Check the message for details.
  • Authentication Issues: If the API key or base URL is incorrect or missing, requests will fail. Verify your credentials and configuration.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Discussion