STEM Connect icon

STEM Connect

Manage telecommunications operations with STEM Connect API

Actions30

Circuit → Update

AI-generated

Overview

The "Circuit Update" operation in the STEM Connect node allows users to update details of an existing telecommunications circuit (end customer circuit) via the STEM Connect API. This operation is useful for managing and maintaining accurate circuit information such as third-party circuit numbers, device serial numbers, VLAN descriptions, portal IDs, PPPoE credentials, and bandwidth speeds.

Typical use cases include:

  • Updating circuit metadata when a customer's service changes.
  • Correcting or adding missing circuit details.
  • Synchronizing circuit information from external systems into STEM Connect.

For example, if a circuit's upload/download speeds change or the associated device serial number is updated, this operation can be used to reflect those changes in the system.

Properties

Name Meaning
Subsystem Selects which subsystem API endpoints to use: Main, Portal, or API
Circuit Number The unique identifier of the circuit to update
Third Party Circuit Number External or third-party reference number for the circuit
Device Serial Number Serial number of the device associated with the circuit
VLAN Description Description of the VLAN configuration related to the circuit
Portal ID Identifier used in the portal subsystem for the circuit
PPPoE Username Username for PPPoE authentication on the circuit
PPPoE Password Password for PPPoE authentication (input is masked)
Download Speed Download bandwidth speed (numeric value)
Upload Speed Upload bandwidth speed (numeric value)

Output

The output is a JSON object representing the updated circuit data returned by the STEM Connect API after the PATCH request to update the circuit. The structure typically includes all the updated fields of the circuit, reflecting the new state after the update.

Example output JSON structure (simplified):

{
  "circuit_no": "string",
  "third_party_circuit_no": "string",
  "device_serial_no": "string",
  "vlan_description": "string",
  "portal_id": "string",
  "pppoe_username": "string",
  "download_speed": 100,
  "upload_speed": 50,
  ...
}

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the STEM Connect API via an API key credential configured in n8n.
  • The node uses HTTP PATCH requests to the endpoint /api/endcustomercircuits/update/{circuitNo}.
  • Proper permissions and valid API credentials are necessary to perform updates.

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.
    • Missing required API credentials or incorrect authentication will cause authorization errors.
    • Invalid data types or malformed input properties may cause validation errors from the API.

  • Error messages:

    • "Circuit not found": Verify that the circuit number exists and is correct.
    • "Unauthorized" or "Authentication failed": Check API key credentials and permissions.
    • "Invalid input": Ensure all provided fields conform to expected formats and types.

  • To resolve errors, verify input parameters, ensure API credentials are correctly set up, and confirm network connectivity to the STEM Connect API.

Links and References

  • STEM Connect API documentation (refer to your organization's internal API docs)
  • n8n documentation on creating and using API credentials
  • General REST API usage guidelines

Discussion