BLbluestaq
Observation

POST /filedrop/udl-rfsignal

Changed on

Upload a new RFSignal with its metadata.

The request body requires a zip file with a .zip file extension containing two files:
1) A file with the .json file extension whose content conforms to the RFSignal_Ingest schema.
2) A second nested zip file with a .zip file extension. The nested zip contains the binary data file and an optional format-specific metadata file. The currently allowed/supported binary data file extension is .sigmf-data. The currently allowed/supported metadata file extensions are .sigmf-meta and .json. Contact the UDL team to request support for additional RF signal formats.

The nested zip will be associated with the id field. Query the metadata via GET /udl/rfsignal, then use GET /udl/rfsignal/getFile/{id} to retrieve the zip file that contains the binary and optional metadata file.

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-rfsignal
  • 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.

typestring required

The RFFileType of the stored samples in the dataset file (e.g. SigMF, etc.).

filenamestring

The filename of the internal .zip file.

filesizeinteger required

The size, in bytes, of the internal .zip file contained within the outer .zip. This refers to the compressed size of the internal archive as stored inside the parent archive and includes all contents of that internal archive (the data file and any optional metadata file). If a POST is provided without an associated internal .zip file, or an invalid filesize, the record will be rejected.

descriptionstring

A text description of the RFSignal recording.

satNointeger

Satellite/catalog number of the target on-orbit object if the RF signal originates from an on-orbit source.

origObjectIdstring

Optional identifier provided by the source to indicate the source object from which this RF Signal was received. This may be an internal identifier of and not necessarily map to a valid satellite number or other ground or mobile source.

idOnOrbitstring

Unique identifier of the target satellite on-orbit object to which this observational data applies. This ID can be used to obtain additional information on an OnOrbit object using the 'get by ID' operation (e.g. /udl/onorbit/{id}). For example, the OnOrbit with idOnOrbit = 25544 would be queried as /udl/onorbit/25544.

idSensorstring

Unique identifier of the sensor from which this observational data was collected. This ID can be used to obtain additional information on a sensor using the 'get by ID' operation (e.g. /udl/sensor/{id}). For example, the sensor with idSensor = abc would be queried as /udl/sensor/abc.

origSensorIdstring

Optional identifier provided by observation source to indicate the sensor identifier which produced this observation. This may be an internal identifier and not necessarily a valid sensor ID.

senlatnumber double

Sensor WGS84 latitude at startTime (if mobile/onorbit), in degrees. If null, can be obtained from sensor info. -90 to 90 degrees (negative values south of equator).

senlonnumber double

Sensor WGS84 longitude at startTime (if mobile/onorbit), in degrees. If null, can be obtained from sensor info. -180 to 180 degrees (negative values west of Prime Meridian).

senaltnumber double

Sensor altitude at startTime (if mobile/onorbit), in kilometers.

taskIdstring

Optional identifier to indicate the specific tasking which produced this observation.

sampleRateinteger

The sample rate of the signal in samples per second.

hashstring

The result of applying the specified hash algorithm to the entity.

hashAlgstring

Name of the algorithm used to generate the hash for this entity (e.g., SHA-256, SHA-512, etc.).

startTimestring date-time required

RFSignal detection start time in ISO 8601 UTC with microsecond precision.

endTimestring date-time

RFSignal detection end time in ISO 8601 UTC with microsecond precision.

frequencynumber double

The detected signal frequency, in hertz.

azimuthnumber double

Azimuth angle in degrees and topocentric coordinate frame.

elevationnumber double

Elevation in degrees and topocentric coordinate frame.

antPlatformAznumber double

Antenna offset from the platform azimuth angle, in degrees.

antPlatformElnumber double

Antenna offset from the platform elevation angle, in degrees.

antRefToPlatformboolean

Boolean if antenna is offset from object pointing azimuth/elevation angle. If yes, then use antenna platform azimuth and antenna platform elevation fields.

referenceFramestring

The reference frame of the cartesian orbital states. If the reference frame is null it is assumed to be J2000.

satPosnumber[]

Three element array, expressing the spacecraft position components, in kilometers, at the startTime, in the specified referenceFrame. The array element order is [x, y, z]. If the referenceFrame is null it is assumed to be J2000.

satVelnumber[]

Three element array, expressing the spacecraft velocity components, in kilometers per second, at the startTime, in the specified referenceFrame. The array element order is [x', y', z']. If the referenceFrame is null it is assumed to be J2000.

satAccelnumber[]

Three element array, expressing the spacecraft acceleration components, in kilometers per second squared, at the startTime, in the specified referenceFrame. The array element order is [x'', y'', z'']. If the referenceFrame is null it is assumed to be J2000.

antennaPolarizationstring

The received signal polarization (e.g. HORIZONTAL, VERTICAL, LEFT_HAND_CIRCULAR, RIGHT_HAND_CIRCULAR).

commentsstring

Additional metadata comments, if needed.

sampleStartinteger required

Sample index of the start of the signal in the dataset.

sampleCountinteger

Number of samples in the dataset.

startFrequencynumber double

Start carrier frequency, in hertz.

endFrequencynumber double

End carrier frequency, in hertz.

externalIdstring

Optional ID from external systems. This field has no meaning within UDL and is provided as a convenience for systems that require tracking of an internal system generated ID.

transactionIdstring

Optional identifier to track a commercial or marketplace transaction executed to produce this data.

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.

sourcestring required

Source of the data.

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.

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.

dataMode'REAL' | 'TEST' | 'EXERCISE' | 'SIMULATED' 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.

origNetworkstring

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

Example request

{
  "id": "026dd511-8ba5-47d3-9909-836149f87686",
  "classificationMarking": "U",
  "type": "SigMF",
  "filename": "examplefile.zip",
  "filesize": 12452456,
  "description": "Capture of FM radio signal",
  "satNo": 25544,
  "origObjectId": "ORIGOBJECT-ID",
  "idOnOrbit": "25544",
  "idSensor": "SENSOR-ID",
  "origSensorId": "ORIGSENSOR-ID",
  "senlat": 45.1,
  "senlon": 179.1,
  "senalt": 0.7539,
  "taskId": "TASK-ID",
  "sampleRate": 48,
  "hash": "315f5bdb76d078c43b8ac0064e4a0164612b1fce77c869345bfc94c75894edd3",
  "hashAlg": "SHA-256",
  "startTime": "2021-01-01T01:01:01.123456Z",
  "endTime": "2021-01-01T02:01:01.123456Z",
  "frequency": 2249997138.92247,
  "azimuth": 197.8,
  "elevation": 46.1,
  "antPlatformAz": 1.1,
  "antPlatformEl": 1.2,
  "antRefToPlatform": true,
  "referenceFrame": "J2000",
  "satPos": [
    -1118.577381,
    6167.831808,
    6167.831808
  ],
  "satVel": [
    -4.25242784,
    5.291107434,
    -3.356493869
  ],
  "satAccel": [
    -0.0012621392,
    0.00645553717,
    0.0006310696
  ],
  "antennaPolarization": "VERTICAL",
  "comments": "Additional Comments.",
  "sampleCount": 16,
  "startFrequency": 2049997138.92247,
  "endFrequency": 2449997138.92247,
  "externalId": "EXTERNAL-ID",
  "transactionId": "TRANSACTION-ID",
  "tags": [
    "TAG1",
    "TAG2"
  ],
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "source": "Bluestaq",
  "sourceDL": "AXE",
  "origin": "THIRD_PARTY_DATASOURCE",
  "dataMode": "TEST",
  "origNetwork": "OPS1"
}

Response

Accepted

Changes

Some revisions have not been checked yet.