STEM Connect icon

STEM Connect

Manage telecommunications operations with STEM Connect API

Actions30

Device → Get

AI-generated

Overview

This node interacts with the STEM Connect API to manage telecommunications devices. Specifically, the "Device" resource with the "Get" operation allows users to retrieve device information from the system. It supports filtering devices by various status flags and serial number, as well as pagination controls.

Common scenarios where this node is beneficial include:

  • Retrieving a list of network devices filtered by configuration or availability status.
  • Fetching specific devices by their serial numbers for inventory or monitoring purposes.
  • Integrating device data retrieval into automated workflows for telecom management.

Practical example:

  • A user wants to get all configured and available devices, limited to 50 results starting from offset 0, to update an asset management database.

Properties

Name Meaning
Subsystem Selects which subsystem's API endpoints to use: Main, Portal, or API.
Offset Pagination offset to start returning results from (default 0).
Limit Maximum number of results to return (minimum 1, default 50).
Configured Filter devices by whether they are configured (true/false). Optional.
Available Filter devices by whether they are available (true/false). Optional.
Billed Filter devices by whether they are billed (true/false). Optional.
Notified Filter devices by whether they are notified (true/false). Optional.
Device Serial Number Filter devices by their serial number (string). Optional query parameter.

Output

The output is an array of JSON objects representing devices retrieved from the STEM Connect API. Each object contains device details as returned by the API, such as serial number, status flags, and other device-specific information.

If multiple devices are returned, each device is output as a separate item in the output array.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the STEM Connect API.
  • The node uses HTTP requests to the STEM Connect API endpoints under the selected subsystem.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

  • Empty results: Check that the filter parameters (e.g., configured, available) are set correctly and that devices matching those filters exist.
  • Invalid serial number: When filtering by serial number, ensure the serial number string is correct and exists in the system.
  • API authentication errors: Verify that the API key credential is valid and has appropriate permissions.
  • Pagination issues: If too few or no results appear, adjust the offset and limit parameters.
  • Network or API errors: Ensure the STEM Connect API service is reachable and operational.

Common error messages will typically come from the API response and may indicate invalid parameters, authentication failure, or server errors. Handling these involves verifying input parameters and API credentials.

Links and References

  • STEM Connect API documentation (refer to your organization's API docs)
  • n8n documentation on creating and using custom nodes and credentials

Discussion