TeleFlow icon

TeleFlow

Interact with TeleFlow API
Join our community

Actions145

Overview

This node interacts with the TeleFlow API to perform various operations on different resources, including devices. Specifically, for the Device - Get operation, it retrieves detailed information about a single device by its unique identifier. This is useful in scenarios where you need to fetch current device details for monitoring, auditing, or further processing within an automation workflow.

For example, you might use this node to:

  • Retrieve configuration or status of a specific device before updating it.
  • Fetch device details to display or log them in another system.
  • Use device data as input for conditional logic or reporting.

Properties

Name Meaning
ID The unique identifier of the device resource to retrieve. This is required.
Fields Optional key-value pairs specifying additional query parameters to filter or customize the request. You can add multiple fields, each with a name and value.

Output

The output is a JSON object representing the device resource retrieved from the TeleFlow API. It contains all the properties of the device as returned by the API, which may include identifiers, names, types, statuses, and other device-specific metadata.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "device-id",
  "name": "Device Name",
  "type": "Device Type",
  "status": "active",
  ...
}

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.

Troubleshooting

  • Missing ID error: If the ID property is not provided, the node will throw an error stating that the ID is required. Ensure you provide a valid device ID.
  • API connection errors: Check that the API key credential and base URL are correctly set up and that the TeleFlow API is reachable.
  • Invalid field names: When using the optional Fields property, ensure that the field names correspond to valid query parameters supported by the TeleFlow API; otherwise, the request may fail or return unexpected results.
  • 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