Report and Activity

GET /udl/h3geohexcell

Changed on

Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/h3geohexcell
  • Auth
    none declared

Query parameters

idH3Geostring required

Unique identifier of the parent H3 Geo record containing this hex cell. (uuid)

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

cellIdstring required

The H3 index represented as a 16 character hexadecimal string.

idH3Geostring

Unique identifier of the parent H3 Geo record containing this hex cell.

coverageinteger

The total number of available observations in the H3 cell during the start/end times.

anomScoreInterferencenumber double

The anomaly score for probable manufactured interference or RF interference; calculated as a ratio of #anomalous obs / #total obs or coverage.

anomScoreSpoofingnumber double

The anomaly score for probable spoofing; calculated as a ratio of #anomalous obs / #total obs or coverage.

changeScorenumber double

The percentage degree of change in the aggregated observables for a particular H3 bin.

rpmMediannumber double

The median received power monitor (RPM) output value for the set of data contained within this cell.

rpmMeannumber double

The mean received power monitor (RPM) output value for the set of data contained within this cell.

rpmMaxnumber double

The max received power monitor (RPM) output value for the set of data contained within this cell.

rpmMinnumber double

The min received power monitor (RPM) output value for the set of data contained within this cell.

rpmSigmanumber double

The standard deviation of the received power monitor (RPM) output value for the set of data contained within this cell.

altMeannumber double

The mean altitude of the set of observations within this cell, measured in kilometers.

altSigmanumber double

The standard deviation of alttitude in the set of observations within this cell, measured in kilometers.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

Application user who created the row in the database, auto-populated by the system.

sourceDLstring

The source data library from which this record was received. This could be a remote or tactical UDL or another data library. If null, the record should be assumed to have originated from the primary Enterprise UDL.

sourcestring required

Source of the data.

originstring

Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

dataMode'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE' required

Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data:

REAL: Data collected or produced that pertains to real-world objects, events, and analysis.

TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics.

EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data.

SIMULATED: Synthetic data generated by a model to mimic real-world datasets.

Example response

[
  {
    "id": "443fg911-4ab6-3d74-1991-372149d87f89",
    "classificationMarking": "U",
    "cellId": "830b90fffffffff",
    "idH3Geo": "026dd511-8ba5-47d3-9909-836149f87686",
    "coverage": 8,
    "anomScoreInterference": 0.125,
    "anomScoreSpoofing": 0.125,
    "changeScore": 12.34,
    "rpmMedian": 48.375,
    "rpmMean": 47.953125,
    "rpmMax": 50.1,
    "rpmMin": 43.1,
    "rpmSigma": 1.23,
    "altMean": 450.1,
    "altSigma": 400.1,
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "sourceDL": "AXE",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST"
  }
]

Changes

    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

    • info

      api operation id findAllWithStream_11 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

    • info

      added the optional property / to the response with the status

Some revisions have not been checked yet.