Models and Simulations

POST /filedrop/udl-globalatmosphericmodel

Changed on

Upload a file with its metadata.

The request body requires a zip file containing exactly two files:
1) A file with the .json file extension whose content conforms to the GlobalAtmosphericModel_Ingest schema.
2) A file with the .geojson file extension.

The JSON and GEOJSON files will be associated with each other other via the id field. Query the metadata via GET /udl/globalatmosphericmodel and use GET /udl/globalatmosphericmodel/getFile/{id} to retrieve the compressed GEOJSON file as .gz extension.

This operation only accepts application/zip media. The application/json request body is documented to provide a convenient reference to the ingest schema.

This operation is intended to be used for automated feeds into UDL. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/filedrop/udl-globalatmosphericmodel
  • 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.

tsstring date-time required

Target time of the model in ISO 8601 UTC format with millisecond precision.

typestring required

Type of data associated with this record (e.g. Global Total Electron Density, Global Total Electron Content).

reportTimestring date-time

The time that this record was created, in ISO 8601 UTC format with millisecond precision.

dataSourceIdentifierstring

A unique identification code or label assigned to a particular source from which atmospheric data originates.

statestring

State value indicating whether the values in this record are PREDICTED or OBSERVED.

cadenceinteger

Model execution cadence, in minutes.

startLatnumber double

WGS-84 starting latitude of model output, in degrees. -90 to 90 degrees (negative values south of equator).

endLatnumber double

WGS-84 ending latitude of model output, in degrees. -90 to 90 degrees (negative values south of equator).

stepLatnumber double

Separation in latitude between subsequent model outputs, in degrees.

numLatinteger

Number of latitude points.

startLonnumber double

WGS-84 starting longitude of model output, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

endLonnumber double

WGS-84 ending longitude of model output, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

stepLonnumber double

Separation in longitude between subsequent model outputs, in degrees.

numLoninteger

Number of longitude points.

startAltnumber double

Starting altitude of model outputs, in kilometers.

endAltnumber double

Ending altitude of model outputs, in kilometers.

numAltinteger

Number of altitude points.

filenamestring

The file name of the uploaded file.

filesizeinteger

The uploaded file size, in bytes. The maximum file size for this service is 104857600 bytes (100MB). Files exceeding the maximum size will be rejected.

checksumValuestring

MD5 value of the data file. If not provided, the ingest/create operation will automatically generate the value.

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",
  "ts": "2024-03-01T11:45:00.123Z",
  "type": "Global Total Electron Density",
  "reportTime": "2024-08-21T21:54:35.123Z",
  "dataSourceIdentifier": "Dragster globally assimilated atmospheric density v2.0",
  "state": "PREDICTED",
  "cadence": 10,
  "startLat": 88.75,
  "endLat": -88.75,
  "stepLat": 2.5,
  "numLat": 72,
  "startLon": 177.5,
  "endLon": -177.5,
  "stepLon": 5.5,
  "numLon": 72,
  "startAlt": 8553.163773,
  "endAlt": 90.125,
  "numAlt": 35,
  "filename": "glotec_elecden.geojson",
  "filesize": 2097152,
  "checksumValue": "938c2cc0dcc05f2b68c4287040cfcf71",
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "sourceDL": "AXE",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST"
}

Response

Accepted

Changes

Some revisions have not been checked yet.