TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to perform various operations on different resources, including "Tariff Profile". Specifically, the "Get Many" operation for the "Tariff Profile" resource retrieves multiple tariff profiles from the TeleFlow system. It allows users to specify filtering fields to narrow down the results.

Common scenarios where this node is beneficial include:

  • Fetching a list of tariff profiles to display or process in workflows.
  • Filtering tariff profiles based on specific criteria such as name or other attributes.
  • Integrating TeleFlow tariff profile data into other systems or reports.

For example, a user might want to retrieve all tariff profiles that match certain field values to automate billing or auditing processes.

Properties

Name Meaning
Fields A collection of field-value pairs used to filter the request. Each pair specifies a field name and its corresponding value to include in the query. This enables more specific queries when retrieving multiple tariff profiles.

The "Fields" property supports multiple entries, allowing users to add several filters.

Output

The output is an array of JSON objects representing the retrieved tariff profiles matching the specified filters. Each item in the output corresponds to one tariff profile returned by the TeleFlow API.

The structure of each JSON object depends on the TeleFlow API response for tariff profiles but generally includes details about each tariff profile.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The node expects the base URL of the TeleFlow API to be configured in the credentials.
  • Network access to the TeleFlow API endpoint is necessary.

Troubleshooting

  • Missing or invalid API credentials: Ensure that the API key and base URL are correctly set up in the node's credentials.
  • Invalid field names or values in filters: Using incorrect field names in the "Fields" property may result in empty responses or errors. Verify field names against TeleFlow API documentation.
  • API request failures: Network issues or API downtime can cause errors. Check connectivity and TeleFlow service status.
  • Error message "ID is required for get/update/delete operations": This does not apply to "Get Many" but indicates that some operations require an ID parameter; ensure correct operation selection.
  • If the node is set to continue on failure, errors will be included in the output JSON under an error key.

Links and References

Discussion