TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

The node interacts with the TeleFlow API to perform various operations on different resources. Specifically, for the Device resource with the Get Many operation, it retrieves multiple device records from the TeleFlow system. Users can specify filtering fields to narrow down the list of devices returned.

This node is beneficial in scenarios where you need to fetch a list of devices managed within TeleFlow, such as inventory management, monitoring device statuses, or integrating device data into other workflows.

Example use case:
You want to retrieve all devices that match certain criteria (e.g., devices of a specific type or name) to process them further in your workflow, like sending notifications or updating records elsewhere.

Properties

Name Meaning
Fields A collection of field-value pairs used to filter the devices returned by the API request. You can add multiple fields to refine the query. For example, specifying name as a field with a value filters devices by their name.

Output

  • The output is an array of JSON objects representing the devices retrieved from the TeleFlow API.
  • Each item in the output corresponds to one device record, containing all the fields returned by the API based on the specified filters.
  • No binary data output is produced by this operation.

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 sends HTTP GET requests to the /devices endpoint of the TeleFlow API.

Troubleshooting

  • Missing or incorrect API credentials: The node requires valid API authentication; ensure the API key and base URL are correctly set.
  • Invalid filter fields: If the fields provided for filtering do not match the API's expected parameters, the request may return no results or an error.
  • API errors: Network issues or server errors from TeleFlow will cause the node to throw errors. Check the error message logged for details.
  • Empty response: If no devices match the filter criteria, the output will be an empty array.

Links and References

Discussion