STEM Connect icon

STEM Connect

Manage telecommunications operations with STEM Connect API

Actions30

Site → Get

AI-generated

Overview

The "STEM Connect" node integrates with the STEM Connect API to manage telecommunications-related data and operations. It supports multiple subsystems and resources, allowing users to retrieve, add, update, or delete various entities such as sites, devices, circuits, ISPs, and more.

For the Site - Get operation specifically, the node fetches a list of site records from the STEM Connect system. This is useful for scenarios where you want to automate workflows involving site information retrieval, such as syncing site data with other systems, generating reports, or triggering actions based on site attributes.

Practical example:

  • Automatically retrieve all sites with pagination support to process or analyze site data in bulk.
  • Use the retrieved site data to update a CRM or asset management system.

Properties

Name Meaning
Subsystem Selects which subsystem's API endpoints to use. Options: Main, Portal, API
Offset (Main subsystem only) Pagination offset to start retrieving site records from (default 0)
Limit (Main subsystem only) Maximum number of site records to return per request (default 50)

Notes on properties for Site - Get operation:

  • The Offset and Limit properties control pagination when fetching site data.
  • These properties are only applicable when the subsystem is set to "Main" and resource is "site" with operation "get".

Output

The output is an array of JSON objects representing site records retrieved from the STEM Connect API. Each item corresponds to one site entity with its associated fields as returned by the API.

  • The exact structure of each site object depends on the STEM Connect API response but typically includes identifiers, names, addresses, and other site-specific details.
  • No binary data output is produced by this operation.

Example output snippet (conceptual):

[
  {
    "id": 123,
    "name": "Site A",
    "address": "123 Telecom St.",
    "city": "Metropolis",
    "state": "CA",
    "postalCode": "90210"
  },
  {
    "id": 124,
    "name": "Site B",
    "address": "456 Network Ave.",
    "city": "Gotham",
    "state": "NY",
    "postalCode": "10001"
  }
]

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the STEM Connect API.
  • The node uses HTTP requests to communicate with the STEM Connect endpoints.
  • No additional external dependencies beyond the configured API authentication.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using unsupported combinations of subsystem/resource/operation may result in errors or empty responses.
    • Pagination parameters (offset, limit) must be valid numbers; invalid values may cause API errors.

  • Error messages:

    • Authentication errors typically indicate invalid or missing API keys.
    • API endpoint errors may occur if the subsystem or resource is misconfigured.
    • If the node returns messages like "requires comprehensive form data implementation," it means that particular operation is not fully implemented in this node version.

  • Resolution tips:

    • Verify API credentials are correctly set up in n8n.
    • Ensure the selected subsystem, resource, and operation are supported and correctly configured.
    • Use valid numeric values for pagination parameters.
    • For unimplemented operations, consider alternative approaches or wait for future node updates.

Links and References

Discussion