TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to perform various operations on different resources, including "Device Template". Specifically, the "Get Many" operation for the "Device Template" resource retrieves multiple device templates from the TeleFlow system. Users can specify filtering fields to narrow down the results.

Common scenarios where this node is beneficial include:

  • Fetching a list of device templates to display or process in workflows.
  • Querying device templates based on specific criteria such as name or other attributes.
  • Integrating TeleFlow device template data into other systems or automations.

For example, a user might want to retrieve all device templates that match certain field values to automate provisioning or reporting tasks.

Properties

Name Meaning
Fields A collection of field-value pairs used to filter the request. Each pair specifies a field name and its desired value to refine the query when retrieving device templates.

The "Fields" property allows adding multiple filters by specifying the field name and corresponding value to include in the API request query string.

Output

The node outputs an array of JSON objects representing the retrieved device templates matching the specified filters. Each item in the output corresponds to one device template returned by the TeleFlow API.

The structure of each JSON object depends on the TeleFlow API response for device templates but generally includes properties describing the device template's attributes.

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 TeleFlow API must be configured in the node credentials.
  • The node sends HTTP requests with JSON content type and expects JSON responses.

Troubleshooting

  • Missing ID error: Not applicable for "Get Many" operation, but other operations require an ID parameter; ensure it is provided when needed.
  • API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Invalid field names or values: Ensure that the field names and values used in the "Fields" property match those supported by the TeleFlow API for device templates.
  • Network or connectivity issues: Check network access to the TeleFlow API endpoint and confirm the base URL is correct.
  • Unexpected API responses: Review the API documentation to confirm the expected response format and adjust filters accordingly.

If the node encounters an error during execution and "Continue On Fail" is enabled, it will output an error message in the JSON output instead of stopping the workflow.

Links and References

Discussion