STEM Connect icon

STEM Connect

Manage telecommunications operations with STEM Connect API

Actions30

Circuit → Get Many

AI-generated

Overview

This node integrates with the STEM Connect API to manage telecommunications operations. Specifically, the "Circuit" resource with the "Get Many" operation allows users to retrieve multiple end customer circuits from the system. This is useful for scenarios where you need to list or analyze many circuits at once, such as generating reports, syncing circuit data with other systems, or monitoring network infrastructure.

For example, a telecom operator could use this node to fetch all active circuits with pagination support, enabling efficient processing of large datasets without overwhelming the system.

Properties

Name Meaning
Subsystem Selects the subsystem of the API endpoints to use. Options: Main, Portal, API
Offset Number indicating the starting point for pagination (only for Main subsystem). Default 0
Limit Maximum number of results to return (only for Main subsystem). Minimum 1, default 50

Output

The output is an array of JSON objects representing the retrieved circuits. Each item corresponds to one end customer circuit with its associated data fields as returned by the STEM Connect API.

  • The json field contains the circuit data.
  • No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the STEM Connect API.
  • The node uses the internal helper function to make HTTP requests to the STEM Connect endpoints.
  • The "Main" subsystem endpoint /api/endcustomercircuits/get is used for fetching multiple circuits.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using an unsupported subsystem or resource combination may result in no data or errors.
    • Pagination parameters (offset, limit) must be valid numbers; otherwise, the API might reject the request.

  • Error messages:

    • Errors from the API are propagated and can appear as messages in the node output if "Continue on Fail" is enabled.
    • Typical error messages include authentication errors, invalid parameter errors, or network connectivity issues.

  • Resolution tips:

    • Verify that the API key credential is correctly set up and has necessary permissions.
    • Ensure the subsystem is set to "Main" when using this operation.
    • Check that offset and limit values are within acceptable ranges.

Links and References

Discussion