TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)

Overview

This node integrates with the TejasNms API, providing various operations on network management resources. Specifically, for the "ONT" resource and the "Delete Customer Service" operation, it allows users to delete one or more customer services identified by their UUIDs from the Optical Network Terminal (ONT) system.

Common scenarios include:

  • Removing obsolete or deactivated customer services from the ONT.
  • Automating cleanup tasks in network management workflows.
  • Managing service lifecycle by programmatically deleting services as part of a larger automation.

Example use case:

  • A network operator wants to automatically delete customer services that have been terminated, using a list of UUIDs obtained from a previous query.

Properties

Name Meaning
UUIDs A string containing one or multiple UUIDs identifying the customer services to be deleted. This is a required field.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will include confirmation of which customer services were successfully deleted or any errors encountered during the process.

If the node supports binary data output, it would relate to any raw response or logs returned by the API, but based on the provided code and context, the primary output is JSON structured data about the deletion results.

Dependencies

  • Requires an API key credential for authenticating with the TejasNms API.
  • Depends on the TejasNms API being accessible and properly configured.
  • Uses internal helper classes for HTTP requests, state management, and operation resolution/execution.
  • No additional external services beyond the TejasNms API are indicated.

Troubleshooting

  • Invalid or missing UUIDs: The operation requires valid UUID strings. Ensure the UUIDs are correctly formatted and not empty.
  • Authentication errors: If the API key credential is invalid or expired, the node will fail to authenticate. Verify the API key and update if necessary.
  • Network issues: Connectivity problems to the TejasNms API endpoint can cause request failures. Check network access and API availability.
  • API errors: The API might return errors if the UUIDs do not correspond to existing customer services or if deletion is not permitted. Review error messages for details.
  • Empty response or no deletion: Confirm that the UUIDs provided actually exist and are deletable.

Links and References

Discussion