STEM Connect icon

STEM Connect

Manage telecommunications operations with STEM Connect API

Actions30

Device → Get by Serial

AI-generated

Overview

This node integrates with the STEM Connect API to manage telecommunications operations. Specifically, the "Device" resource with the "Get by Serial" operation allows users to retrieve detailed information about a specific network device by providing its serial number. This is useful in scenarios where you need to quickly fetch device details for inventory management, troubleshooting, or auditing purposes.

Practical example:
If you have a device's serial number and want to obtain its configuration status, availability, billing state, or other metadata stored in STEM Connect, this operation will query the API and return the device's data.

Properties

Name Meaning
Subsystem Selects which subsystem of the STEM Connect API to use. Options: Main, Portal, API.
Serial Number The unique serial number of the device to retrieve. This is required for this operation.

Output

The output is an array of JSON objects representing the device data returned from the STEM Connect API endpoint /api/devices/get/{serialNo}. Each object contains detailed properties of the device identified by the given serial number.

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.
  • Proper configuration of the API credentials in n8n is necessary for successful communication.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent serial number will likely result in an error or empty response.
    • Missing or incorrect API credentials will cause authentication failures.
    • Network connectivity issues can prevent the node from reaching the STEM Connect API.

  • Error messages:

    • Errors thrown by the API (e.g., 404 Not Found if the serial number does not exist) will be surfaced unless "Continue On Fail" is enabled.
    • Authentication errors due to invalid credentials will typically indicate unauthorized access.

  • Resolution tips:

    • Verify the serial number is correct and exists in the STEM Connect system.
    • Ensure API credentials are correctly set up and valid.
    • Check network connectivity and firewall settings that might block API calls.

Links and References

Discussion