BLbluestaq
Ephemeris

GET /udl/ephemeris/history

Changed on

Service operation to dynamically query historical 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/ephemeris/history
  • Auth
    none declared

Query parameters

columnsstring

optional, fields for retrieval. When omitted, ALL fields are assumed. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid query fields that can be selected.

esIdstring required

Unique identifier of the parent EphemerisSet, auto-generated by the system. The esId (ephemerisSet id) is used to identify all individual ephemeris states associated with a parent ephemerisSet. (uuid)

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.

esIdstring

Unique identifier of the parent EphemerisSet, auto-generated by the system. The esId (ephemerisSet id) is used to identify all individual ephemeris states associated with a parent ephemerisSet.

tsstring date-time required

Time associated with the Ephemeris Point, in ISO8601 UTC format.

xposnumber double required

Cartesian X position of target, in km, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.

yposnumber double required

Cartesian Y position of target, in km, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.

zposnumber double required

Cartesian Z position of target, in km, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.

xvelnumber double required

Cartesian X velocity of target, in km/sec, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.

yvelnumber double required

Cartesian Y velocity of target, in km/sec, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.

zvelnumber double required

Cartesian Z velocity of target, in km/sec, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.

xaccelnumber double

Cartesian X acceleration of target, in km/sec^2, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.

yaccelnumber double

Cartesian Y acceleration of target, in km/sec^2, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.

zaccelnumber double

Cartesian Z acceleration of target, in km/sec^2, in the specified EphemerisSet referenceFrame. If referenceFrame is null then J2K should be assumed.

covnumber[]

Covariance matrix, in kilometer and second based units, in the specified Ephemeris Set covReferenceFrame.

If the covReferenceFrame from the EphemerisSet table is null it is assumed to be J2000.

The array values represent the lower triangular half of the position-velocity covariance matrix. The size of the covariance matrix is dynamic, depending on whether the covariance for position only or position & velocity.

The covariance elements are position dependent within the array with values ordered as follows:

          x    y    z    x'   y'   z'

x         1

y         2    3

z         4    5    6

x'        7    8    9    10

y'        11   12   13   14   15

z'        16   17   18   19   20   21

The array containing the covariance matrix elements will be of length 6 for position only covariance, or length 21 for position-velocity covariance. The cov array should contain only the lower left triangle values from top left down to bottom right, in order.

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.

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.

idOnOrbitstring

Unique identifier of the on-orbit satellite object.

origObjectIdstring

Optional identifier provided by ephemeris source to indicate the target object of this ephemeris. This may be an internal identifier and not necessarily map to a valid satellite number.

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.

Example response

[
  {
    "id": "EPHEMERIS-ID",
    "classificationMarking": "U",
    "esId": "ES-ID",
    "ts": "2018-01-01T16:00:00.123456Z",
    "xpos": 1.1,
    "ypos": 1.1,
    "zpos": 1.1,
    "xvel": 1.1,
    "yvel": 1.1,
    "zvel": 1.1,
    "xaccel": 1.1,
    "yaccel": 1.1,
    "zaccel": 1.1,
    "cov": [
      1.1,
      2.4,
      3.8,
      4.2,
      5.5,
      6
    ],
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "dataMode": "TEST",
    "idOnOrbit": "ONORBIT-ID",
    "origObjectId": "ORIGOBJECT-ID",
    "origin": "THIRD_PARTY_DATASOURCE"
  }
]

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • info

      api operation id findAllHistory_19 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.