TeleFlow icon

TeleFlow

Interact with TeleFlow API

Actions82

Overview

This node interacts with the TeleFlow API to perform various operations on different resources. Specifically, for the Device Template resource with the Get operation, it retrieves detailed information about a specific device template by its unique ID. This is useful when you need to fetch configuration or metadata of a particular device template within your TeleFlow environment.

Practical examples include:

  • Retrieving a device template's details before applying it to a new device.
  • Fetching device template data to audit or verify configurations.
  • Integrating device template information into workflows that automate device provisioning or management.

Properties

Name Meaning
ID The unique identifier of the device template to retrieve. This is required for the Get operation.
Fields Optional field-value pairs to filter or specify additional query parameters in the request. You can add multiple fields, each with a name and value.

Output

The output is a JSON object representing the retrieved device template's data as returned by the TeleFlow API. It contains all the properties and metadata associated with the specified device template ID.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "type": "string",
  "configuration": { /* device template specific settings */ },
  ...
}

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The node uses HTTP requests to communicate with the TeleFlow API endpoint configured via credentials.
  • The base URL for the API is set from the node credentials.

Troubleshooting

  • Missing ID error: If the ID property is not provided for the Get operation, the node will throw an error stating "ID is required for get operation". Ensure you provide a valid device template ID.
  • API connection issues: Errors related to network connectivity or authentication failures may occur if the API key or base URL is incorrect or missing.
  • Invalid field names: Providing unsupported or incorrect field names in the Fields property may result in unexpected API responses or errors.
  • To resolve these, verify the input parameters, ensure correct API credentials, and consult the TeleFlow API documentation for valid query parameters.

Links and References

Discussion