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 Tenant Audit resource with the Update operation, it updates an existing tenant audit record by its unique ID. This is useful in scenarios where you need to modify audit details related to tenants, such as updating audit metadata or correcting information.

Practical example: You have a tenant audit entry that tracks changes or events for a tenant, and you want to update some fields of this audit record (e.g., audit name or other attributes) based on new information or corrections.

Properties

Name Meaning
ID The unique identifier of the tenant audit record to update. This is required.
Fields A collection of field-value pairs specifying which fields to include or update in the request. Each pair consists of a field name and its corresponding value.

Note: For the Update operation, the node expects the ID property and uses additional fields depending on the resource type. However, for Tenant Audit specifically, the bundled code does not explicitly show additional fields being set during update, so only the ID and any provided fields are relevant.

Output

  • The output is a JSON object representing the updated tenant audit record as returned by the TeleFlow API.
  • The structure of the JSON depends on the API response but typically includes the updated properties of the tenant audit.
  • No binary data output is indicated.

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 requests with JSON content type and expects JSON responses.

Troubleshooting

  • Missing ID error: If the ID property is not provided for the update operation, the node will throw an error stating "ID is required for update operation." Ensure the ID is correctly set.
  • API errors: Errors from the TeleFlow API (e.g., invalid fields, unauthorized access) will be logged and can cause the node to fail unless "Continue On Fail" is enabled.
  • Field validation: Incorrect or unsupported field names/values in the fields collection may result in API errors. Verify field names against TeleFlow API documentation.
  • Credential issues: Invalid or missing API credentials will prevent successful API calls.

Links and References

Discussion