STEM Connect icon

STEM Connect

Manage telecommunications operations with STEM Connect API

Actions30

Circuit → Delete

AI-generated

Overview

This node integrates with the STEM Connect API to manage telecommunications operations. Specifically, for the Circuit - Delete operation, it allows users to delete an existing end customer circuit by specifying its circuit number. This is useful in scenarios where a circuit is no longer needed or must be removed from the system, such as decommissioning a service or correcting erroneous entries.

Practical example:

  • A telecom operator wants to automate the removal of circuits that have been terminated by customers. Using this node, they can input the circuit number and delete the corresponding circuit record directly via the API without manual intervention.

Properties

Name Meaning
Subsystem Selects which subsystem of the STEM Connect API to use. Options: Main, Portal, API.
Circuit Number The unique identifier of the circuit to delete.

Output

The output is a JSON object representing the response from the STEM Connect API after attempting to delete the specified circuit. Typically, this will confirm successful deletion or provide error details if the operation failed.

Example output structure (simplified):

{
  "message": "Circuit deleted successfully"
}

If an error occurs, the output JSON may contain an error field with the error message.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the STEM Connect API.
  • Requires an API authentication credential configured in n8n (an API key or token).
  • The node uses the generic stemConnectApiRequest function to make HTTP requests to the API endpoints.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent circuit number will likely result in an error from the API indicating the circuit was not found.
    • Network connectivity issues or incorrect API credentials will cause authentication or connection errors.
    • Attempting to delete a circuit that is in use or linked to other resources might be rejected by the API depending on business rules.

  • Error messages:

    • "Circuit not found": Verify the circuit number is correct and exists.
    • "Unauthorized" or "Authentication failed": Check that the API credentials are correctly configured and valid.
    • "Failed to delete circuit": Review API documentation or logs for more details; ensure the circuit is eligible for deletion.

Links and References

Discussion