STEM Connect icon

STEM Connect

Manage telecommunications operations with STEM Connect API

Actions30

Circuit → Generate TOC

AI-generated

Overview

The node integrates with the STEM Connect API to manage telecommunications operations. Specifically, for the Circuit resource and the Generate TOC operation, it generates a Take Over Certificate (TOC) PDF document for a specified circuit number. This is useful in scenarios where you need to produce official documentation related to customer circuits, such as when transferring or auditing circuit information.

Practical examples:

  • Automatically generate a TOC PDF after updating circuit details.
  • Use the generated TOC in workflows that require sending official circuit documentation to customers or partners.
  • Integrate TOC generation into billing or provisioning automation pipelines.

Properties

Name Meaning
Subsystem Selects the subsystem of the STEM Connect API to use. Options: Main, Portal, API
Circuit Number The unique identifier of the circuit for which the TOC PDF will be generated

Output

The output JSON contains the response from the STEM Connect API after requesting TOC generation for the specified circuit. Typically, this will include confirmation data or metadata about the generated TOC PDF.

Since the operation involves generating a PDF, the output may represent either a success message or metadata about the generated file. The node does not directly output binary PDF data but returns the API response related to the TOC generation request.

Dependencies

  • Requires an API key credential for authenticating with the STEM Connect API.
  • The node calls the /api/endcustomercircuits/generate-toc endpoint via a POST request with the circuit number.
  • No additional external dependencies are required beyond the configured STEM Connect API credentials.

Troubleshooting

  • Common issues:

    • Missing or incorrect circuit number parameter will cause the API call to fail.
    • Invalid or expired API authentication token can result in authorization errors.
    • Network connectivity issues to the STEM Connect API endpoint.

  • Error messages:

    • Errors returned from the API will be propagated as error messages in the node output.
    • If the node is set to continue on failure, errors will appear in the JSON output under an error field.

  • Resolutions:

    • Ensure the "Circuit Number" property is correctly set and corresponds to an existing circuit.
    • Verify that the API key credential is valid and has necessary permissions.
    • Check network access and API endpoint availability.

Links and References

Discussion