STEM Connect icon

STEM Connect

Manage telecommunications operations with STEM Connect API

Actions30

Circuit → Get

AI-generated

Overview

The node integrates with the STEM Connect API to manage telecommunications operations. Specifically, for the Circuit - Get operation, it retrieves detailed information about a specific end customer circuit identified by its circuit number.

This node is beneficial in scenarios where users need to fetch circuit details such as configuration, associated device serial numbers, VLAN descriptions, or other metadata related to telecommunications circuits managed within STEM Connect.

Practical example:
A telecom operator wants to automate the retrieval of circuit details before performing maintenance or billing operations. Using this node, they can input a circuit number and get all relevant data about that circuit from the STEM Connect system.

Properties

Name Meaning
Subsystem Selects the subsystem of the STEM Connect API to use. Options: Main, Portal, API
Offset (For pagination) The starting point offset when retrieving multiple records (not used here)
Limit (For pagination) Maximum number of results to return when retrieving multiple records (not used here)
Circuit Number The unique identifier of the circuit to retrieve information for

Output

  • The output JSON contains the detailed data of the requested circuit as returned by the STEM Connect API endpoint /api/endcustomercircuits/get/{circuitNo}.
  • The structure depends on the API response but typically includes fields describing the circuit's properties such as circuit number, third party circuit number, device serial number, VLAN description, portal ID, PPPoE credentials, download/upload speeds, and other metadata.
  • The node does not output binary data for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the STEM Connect API.
  • The node uses the stemConnectApiRequest helper function to make HTTP requests to the STEM Connect endpoints.
  • No additional external services are required beyond access to the STEM Connect API.

Troubleshooting

  • Common issues:

    • Invalid or missing circuit number parameter will cause the API request to fail.
    • Network connectivity or authentication errors if the API key is invalid or expired.
    • If the circuit number does not exist, the API may return an error or empty result.

  • Error messages:

    • Errors thrown by the API will be propagated unless "Continue On Fail" is enabled, in which case the error message will be included in the output JSON under an error field.
    • Typical error resolution involves verifying the circuit number, checking API credentials, and ensuring network connectivity.

Links and References

Discussion