BLbluestaq
Observation

GET /udl/ecpedr/tuple

Changed on

Service operation to dynamically query data and only return specified columns/fields. Requested columns are specified by the 'columns' query parameter and should be a comma separated list of valid fields for the specified data type. classificationMarking is always returned. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information. An example URI: /udl/elset/tuple?columns=satNo,period&epoch=>now-5 hours would return the satNo and period of elsets with an epoch greater than 5 hours ago.

Request

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

Query parameters

columnsstring required

Comma-separated list of valid field names for this data type to be returned in the response. Only the fields specified will be returned as well as the classification marking of the data, if applicable. See the ‘queryhelp’ operation for a complete list of possible fields.

obTimestring date-time required

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

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system if not provided on create operations.

classificationMarkingstring required

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

obTimestring date-time required

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

idSensorstring

Unique identifier of the reporting sensor. 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.

idOnOrbitstring

Unique identifier of the on-orbit satellite hosting the sensor.

satNointeger

Satellite/catalog number of the on-orbit satellite hosting the 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.

origObjectIdstring

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

genTimestring date-time

Time when message was generated in ISO 8601 UTC format with millisecond precision.

genSystemstring

System which generated the message.

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

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

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

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.

transactionIdstring

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

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": "026dd511-8ba5-47d3-9909-836149f87686",
    "classificationMarking": "U",
    "obTime": "2025-03-13T17:00:00.123456Z",
    "idSensor": "REACH-101",
    "idOnOrbit": "ONORBIT-ID",
    "satNo": 101,
    "origSensorId": "CEASE-3",
    "origObjectId": "WSF-M SV1",
    "genTime": "2025-03-13T18:00:00.123Z",
    "genSystem": "cpuch2.aero.org",
    "senPos": [
      5893.74,
      1408.8,
      3899.38
    ],
    "senReferenceFrame": "TEME",
    "tags": [
      "TAG1",
      "TAG2"
    ],
    "transactionId": "TRANSACTION-ID",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "sourceDL": "AXE",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST",
    "ecpedrMeasurements": [
      {
        "msgNumber": 21,
        "chanId": "H05E",
        "chanEnergyLow": 58.4,
        "chanEnergyHigh": 0.003495,
        "chanUnit": "keV",
        "chanType": "INTEGRAL",
        "species": "ELECTRON",
        "obType": "FLUX",
        "obValue": 31473.9,
        "obQuality": "BAD",
        "obQualityIndicator": "DATA SPIKE",
        "obUoM": "#/MeV/cm^2/sr/s"
      }
    ]
  }
]

Changes

  • 173e4aff893fRevision changes
    • breaking

      the /// response property's maxLength was increased from 24 to 64 for the response status

    • breaking

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

    • breaking

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

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • 45631f9bb3f0Revision changes
    • info

      endpoint added

Some revisions have not been checked yet.