BLbluestaq
Report and Activity

POST /udl/h3geo

Changed on

Service operation to take a single H3Geo record as a POST body and ingest into the database. This operation does not persist any H3GeoHexCell points that may be present in the body of the request. This operation is not intended to be used for automated feeds into UDL. Data providers should contact the UDL team for specific role assignments and for instructions on setting up a permanent feed through an alternate mechanism.

Request

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

Request body

idstring

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

classificationMarkingstring required

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

resolutioninteger

H3 resolution (0 – 15) for the data set. At this time, UDL supports a resolution of 3 or less.

startTimestring date-time required

Start time for this H3 Geo data set in ISO 8601 UTC with millisecond precision.

endTimestring date-time

End time for this H3 Geo data set in ISO 8601 UTC with millisecond precision.

centerFreqnumber double

The center frequency of this H3 Geo data set measured in megahertz.

numCellsinteger required

The number of cells associated with this H3 Geo data set. At this time, UDL supports up to 50,000 cells.

typestring

An optional field containing the type of data that is represented by this H3 Geo data set.

tagsstring[]

Optional array of provider/source specific tags for this data, where each element is no longer than 32 characters, used for implementing data owner conditional access controls to restrict access to the data. Should be left null by data providers unless conditional access controls are coordinated with the UDL team.

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 request

{
  "id": "026dd511-8ba5-47d3-9909-836149f87686",
  "classificationMarking": "U",
  "resolution": 3,
  "startTime": "2024-07-02T00:00:00.123Z",
  "endTime": "2024-07-03T00:00:00.123Z",
  "centerFreq": 1575.42,
  "cells": [
    {
      "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"
    }
  ],
  "numCells": 1,
  "type": "Cell Towers",
  "tags": [
    "TAG1",
    "TAG2"
  ],
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "sourceDL": "AXE",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST"
}

Response

Success

Changes

  • 45631f9bb3f0Revision changes
    • breaking

      the // request property's minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

  • 75f764c843a9Revision changes
    • info

      api operation id create_51 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

    • info

      added the new optional request property //

Some revisions have not been checked yet.