Skip to content

NovaStar Data / Service / dataSources

Overview

The dataSources service queries provides a list of data sources (including source line numbers) that are used to indicate the source of data, corresponding to one or more of the following:

  • program that is collecting the data (e.g., ALERT2 data feed or data import)
  • communication channel (e.g., ALERT2 ASCII or binary and radio frequency)

The source line number is a unique integer that is inserted in the data report (data record) flag value. If data are received from more than one source (e.g., multiple ALERT decoders), both line numbers will be included in the flag. The source line numbers in data reports are useful for troubleshooting whether a data collection source is working as intended. The ts service can be used with a time series identifier like the following:

Source:1.NovaStar5.DataReport-Count.1Hour

Source line numbers are currently extracted from the following data.

Source Line Number Providers

Resource Type Description
Configuration (alert_port#) The source line number is taken from the -S option. If the -S#,# syntax is detected, two source line numbers are output, with different values for isConcentrator.
Configuration (poll_port#) Currently not handled.
DataImport The source=# command option is evaluated to determine the source line number.
Scheduler Commands with -S#, -S #, -S#,#, or -S #,# parameter is evaluated to determine the source line number(s).

Data Report Line Number Ambiguity

NovaStar currently has a limitation that line numbers included in the data report flags are expected to be single digits if the record is updated. Consequently, the source line numbers may be ambiguous if a system uses multi-digit line numbers where the digits are shared. Line numbers can be used unambiguously in systems where only single-digit line numbers are used.

The line number 99 is often used for manual data loads, such as when restoring data after a failover. The original insert will have a line number of 99, but will be reduced to 9 and other digits if the record is updated.

To fix this limitation, an enhancement is planned to update the flags format to syntax like VE,1,2,12,21, where the source line numbers are unique and delimited with commas, listed in the order that the source line numbers are inserted. Once phased in, the latest features for filtering on line number will be available on all systems.

Service Editor

The api-ui service can be used to edit a service request.

Service Syntax

The service syntax is as follows:

  • https is typically used for public servers and http may be used in private networks
  • filter parameters are AND'ed unless otherwise noted
https://server/novastar/data/api/v1/dataSources?param1=value1&param2=value2,...

Service Parameters

Type Parameter                           Description Default                  
Filter description Data source description. Use * at front or back to match a substring.
name Data source name. Use * at front or back to match a substring.
Output format Format for output: csv, json, or xml. See format in the Service Parameter Reference. json
formatPrettyPrint Indicate whether json formatting should be pretty: false or true. See formatPrettyPrint in the Service Parameter Reference. true
jsonFormat Indicate the json format: bare, full, or named. See jsonFormat in the Service Parameter Reference. full
Developer debug Indicate whether additional debug messages should be printed to the log file, used for troubleshooting: false or true. false

Data Description

The following table describes data returned by the service.

Data Description (alphabetized)

Data Item                                                   Data Type Description
description string Source description from the configuration or data import description.
id integer Source line number, may occur in multiple objects (see the name for configuration table data and resourceId for imports for a unique identifier).
name string Source name from the configuration or data import name.
isConcentrator boolean Used with ALERT/ALERT2 data sources to indicate data from a concentrator.
resourceType string The type of data resource for the data source:
  • Configuration - if the data source is a data collection process listed in the configuration data
  • DataImport - if the data source is a data import
resourceId integer Internal database identifier for the resource, used to link to other data:
  • Configuration resource type - not used (use the name)
  • DataImport resource type - data import identifier

Examples

https://server/novastar/data/api/v1/dataSources

{
  "apiVersion" : {
    "apiVersionMajor" : "1",
    "apiVersionMinor" : "13",
    "apiVersionMicro" : "0",
    "apiVersionModifier" : "",
    "apiVersionDate" : "2025-08-05",
    "apiVersionTime" : "",
    "apiDotDelimitedVersion" : "1.13.0"
  },
  "attributionAndUsage" : {
    "providerOrganizationText" : "",
    "providerOrganizationUri" : "",
    "dataPolicyUri" : "",
    "disclaimerText" : "",
    "disclaimerUri" : "",
    "licenseText" : "",
    "licenseUri" : "",
    "usageConstraintsText" : "",
    "usageConstraintsUri" : "",
    "recommendedAttributionText" : ""
  },
  "responseInfo" : {
    "urlOriginal" : "Unknown",
    "urlOriginalEncoded" : "Unknown",
    "url" : "http://vb-sam-bullseye-100d-nsdataws-dev:8080/novastar-rest/api/v1/dataSources",
    "urlEncoded" : "http://vb-sam-bullseye-100d-nsdataws-dev:8080/novastar-rest/api/v1/dataSources",
    "periodStart" : null,
    "periodEnd" : null,
    "size" : 5,
    "queryStart" : "2025-08-04T15:04:58.642059-06:00",
    "queryMs" : 26,
    "queryTargetMs" : -999,
    "queryTargetMet" : null,
    "isCached" : false,
    "cacheExpirationTime" : null
  },
  "dataSources" : [
    {
      "id" : 8,
      "name" : "alert_port1",
      "description" : "San Bernardino Iridum Feed",
      "isConcentrator" : false,
      "resourceType" : "Configuration",
      "resourceId" : null
    },
    {
      "id" : 4,
      "name" : "alert_port2",
      "description" : "ALERT2 Decoder (169.4375Hz)",
      "isConcentrator" : false,
      "resourceType" : "Configuration",
      "resourceId" : null
    },
    {
      "id" : 4,
      "name" : "alert_port2",
      "description" : "ALERT2 Decoder (169.4375Hz)",
      "isConcentrator" : true,
      "resourceType" : "Configuration",
      "resourceId" : null
    },
    {
      "id" : 0,
      "name" : "50386 Satellite Import",
      "description" : "",
      "isConcentrator" : false,
      "resourceType" : "DataImport",
      "resourceId" : 1
    },
    {
      "id" : 0,
      "name" : "Daily APDUID",
      "description" : "",
      "isConcentrator" : false,
      "resourceType" : "DataImport",
      "resourceId" : 2
    }
  ]
}

Troubleshooting

See Also