BLbluestaq
Observation

GET /udl/spaceenvobservation

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/spaceenvobservation
  • Auth
    none declared

Query parameters

obTimestring date-time required

Time of the observation, in ISO 8601 UTC format with millisecond precision. (YYYY-MM-DDTHH:MM:SS.sssZ)

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.

msgTypestring

The type of message associated with this record.

genSystemstring

The external system which generated the message, if applicable.

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.

dataTypestring

The data type (e.g. AP, AURORAL FLUX, ECP, KINDEX, PROPAGATED SOLAR WIND, XRAY FLUX, etc.) of observations in this record.

genTimestring date-time

The time at which the associated data message was generated, in ISO 8601 UTC format with millisecond precision.

forecastboolean

Flag indicating that this record contains forecast data.

derivedboolean

Flag indicating that this record contains derived data.

idOnOrbitstring

Unique identifier of the on-orbit satellite hosting the sensor which produced this data.

satNointeger

Satellite/catalog number of the on-orbit satellite hosting the sensor which produced this data.

origObjectIdstring

Optional identifier provided by the record source to indicate the satellite hosting the sensor which produced this data. This may be an internal identifier and not necessarily map to a valid satellite number.

idSensorstring

Unique identifier of the reporting sensor.

origSensorIdstring

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

observatoryTypestring

The type of observatory from which this data was collected (e.g. FACILITY, ONORBIT, NETWORK, etc.).

observatoryNamestring

The name of the observatory from which this data was collected.

observatoryNotesstring

Additional notes concerning the observatory.

instrumentTypestring

The type of instrument from which this data was collected (e.g. ANTENNA, CHANNELTRON, INTERFEROMETER, MAGNETOMETER, RADIOMETER, etc.).

latnumber double

WGS-84 spacecraft/sensor latitude sub-point at observation time, represented as -90 to 90 degrees (negative values south of equator).

lonnumber double

WGS-84 spacecraft/sensor longitude sub-point at observation time, represented as -180 to 180 degrees (negative values west of Prime Meridian).

altnumber double

Spacecraft/sensor altitude at observation time, expressed in kilometers above WGS-84 ellipsoid.

senReferenceFrame'J2000' | 'EFG/TDR' | 'ECR/ECEF' | 'TEME' | 'ITRF' | 'GCRF'

The reference frame of the observing spacecraft/sensor state. If the senReferenceFrame is null it is assumed to be J2000.

senPosnumber[]

Three element array, expressing the observing spacecraft/sensor position vector components at observation time, in kilometers, in the specified senReferenceFrame. If senReferenceFrame is null then J2000 should be assumed. The array element order is [xpos, ypos, zpos].

senVelnumber[]

Three element array, expressing the observing spacecraft/sensor velocity vector components at observation time, in kilometers/second, in the specified senReferenceFrame. If senReferenceFrame is null then J2000 should be assumed. The array element order is [xvel, yvel, zvel].

measTypestring

The sensor measurement type of the observation data contained in this record.

senEnergyLevelstring

The energy level bin of the sensor associated with this measurement.

obSetIdstring

A user-defined name or ID of a set of observations, if applicable. Used for identifying multiple observation records as part of one observation set.

particleTypestring

The particle type (AEROSOL, ALPHA PARTICLE, ATOM, DUST, ELECTRON, ION, MOLECULE, NEUTRON, POSITRON, PROTON) associated with this measurement.

obTimestring date-time required

Time of the observation, in ISO 8601 UTC format with millisecond precision.

qualitystring

The quality of the overall data contained in this record. The quality indicator value may vary among providers and may be a generalized statement (BAD, GOOD, UNCERTAIN, UNKNOWN) or a numeric value. Users should consult the data provider to verify the usage of the quality indicator.

descriptionstring

Descriptive or additional information associated with this observation record.

descriptorstring

Optional source-provided and searchable metadata or descriptor of the data.

srcTypsstring[]

Array of UDL record types (AIS, CONJUNCTION, DOA, ELSET, EO, ESID, GROUNDIMAGE, POI, MANEUVER, MTI, NOTIFICATION, RADAR, RF, SGI, SIGACT, SKYIMAGE, SPACEENVOB, SV, TRACK) that are related to this observation record. See the associated 'srcIds' array for the record UUIDs, positionally corresponding to the record types in this array. The 'srcTyps' and 'srcIds' arrays must match in size.

srcIdsstring[]

Array of UUIDs of the UDL data records that are related to this observation record. See the associated 'srcTyps' array for specific types of data, positionally corresponding to the UUIDs in this array. The 'srcTyps' and 'srcIds' arrays must match in size. See the corresponding srcTyps array element of the data type of the UUID and use the appropriate API operation to retrieve that object.

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.

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' | '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.

origNetworkstring

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

Example response

[
  {
    "id": "f13f82b8-5d2a-407a-b3f3-1fe30ca79eae",
    "classificationMarking": "U",
    "msgType": "SODM",
    "genSystem": "System Name",
    "externalId": "fe4ad5dc-0128-4ce8-b09c-0b404322025e",
    "dataType": "ECP",
    "genTime": "2023-02-10T19:48:09.934Z",
    "forecast": true,
    "idOnOrbit": "41866",
    "satNo": 41866,
    "origObjectId": "41866",
    "idSensor": "ECP-1",
    "origSensorId": "ECP-1",
    "observatoryType": "ONORBIT",
    "observatoryName": "GOES-16",
    "observatoryNotes": "Notes",
    "instrumentType": "MAGNETOMETER",
    "lat": 38.8339,
    "lon": -104.8214,
    "alt": 35785.3732,
    "senReferenceFrame": "J2000",
    "senPos": [
      4174.78541785946,
      -9969.69867853067,
      40733.9284531208
    ],
    "senVel": [
      0.727059797295872,
      0.298037087322647,
      0.00157064850994095
    ],
    "measType": "ENERGETIC PARTICLES",
    "senEnergyLevel": "0500-700 keV",
    "obSetId": "ECPOBSET-478125",
    "particleType": "PROTON",
    "obTime": "2023-06-07T14:17:39.653Z",
    "seoList": [
      {
        "obType": "INTEGRAL FLUX",
        "obUoM": "particles/cm^2/s/sr",
        "obValue": 0.487687826,
        "obString": "C1.3",
        "obArray": [
          1.7,
          35.6,
          21.2,
          19.01
        ],
        "obBool": true,
        "obQuality": "GOOD",
        "obDescription": "Observation Description Text"
      }
    ],
    "quality": "GOOD",
    "description": "Observation Data Description Text",
    "descriptor": "energetic charged particle",
    "srcTyps": [
      "SPACEENVOB",
      "SGI"
    ],
    "srcIds": [
      "615236d7-d464-4b8c-9b0b-45994e017d80",
      "8a38e3d6-35fd-4bda-b883-e3724e6bc6b9"
    ],
    "createdAt": "2023-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "OPS1",
    "dataMode": "TEST",
    "origNetwork": "OPS1"
  }
]

Changes

  • 173e4aff893fRevision changes
    • breaking

      the / response property's minItems was decreased from 3 to 0 for the response status

    • breaking

      the / response property's minItems was decreased from 3 to 0 for the response status

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

Some revisions have not been checked yet.